Bump version, provide build script
This commit is contained in:
@@ -3,14 +3,13 @@
|
||||
<PropertyGroup>
|
||||
<!-- Assembly Properties -->
|
||||
<OutputType>Exe</OutputType>
|
||||
<PackAsTool>true</PackAsTool>
|
||||
<ToolCommandName>irdkit</ToolCommandName>
|
||||
<PackageOutputPath>./nupkg</PackageOutputPath>
|
||||
<TargetName>irdkit</TargetName>
|
||||
<AssemblyName>irdkit</AssemblyName>
|
||||
<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
|
||||
<RuntimeIdentifiers>win-x86;win-x64;win-arm64;linux-x64;linux-arm64;osx-x64;osx-arm64</RuntimeIdentifiers>
|
||||
<LangVersion>latest</LangVersion>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
<Version>0.3.3</Version>
|
||||
<Version>0.4.0</Version>
|
||||
|
||||
<!-- Package Properties -->
|
||||
<Authors>Deterous</Authors>
|
||||
|
||||
+40
-8
@@ -1,9 +1,41 @@
|
||||
## How to use IRDKit
|
||||
# How to use IRDKit
|
||||
|
||||
IRDKit is a tool that allows direct use of LibIRD functionality from the command line interface. The basic usage is:
|
||||
```
|
||||
irdkit create game.iso
|
||||
irdkit info game.ird
|
||||
irdkit diff game1.ird game2.ird
|
||||
```
|
||||
For detailed usage, run `irdkit help`
|
||||
IRDKit is a tool that allows direct use of LibIRD functionality from the command line interface.
|
||||
For full help instructions, run `irdkit help`
|
||||
|
||||
## Creating ISOs
|
||||
|
||||
For all options, run `irdkit help create`
|
||||
|
||||
To create an IRD from an ISO, run `irdkit create game.iso`
|
||||
Multiple ISOs can be processed at once with `irdkit create game1.iso game2.iso`
|
||||
Or a whole directory of ISOs can be processed with `irdkit create ./ISO`, or recursively with `irdkit create -r ./ISO`
|
||||
|
||||
The IRD will be created in the same folder as the ISO, with the same filename.
|
||||
A different IRD path and/or filename can be defined with `-o` or `--output=`
|
||||
|
||||
### Key
|
||||
By default, IRDs will be created by pulling keys from redump.org
|
||||
A key can be manually provided with `-k` or `--key=`
|
||||
A key file can be provided with `-f game.key` or `--key-file=`
|
||||
A key from GetKey log file can be used with `-l game.getkey.log` or `--getkey-log=`
|
||||
|
||||
### PIC
|
||||
By default, a PIC will be generated assuming a default layerbreak
|
||||
A layerbreak value can be provided with `-b` or `--layerbreak=`
|
||||
A PIC from a GetKey log file can be used with `-l game.getkey.log` or `--getkey-log=`
|
||||
|
||||
## Printing info
|
||||
|
||||
For all options, run `irdkit help info`
|
||||
|
||||
To print info about an ISO or IRD file, run `irdkit info game.iso` or `irdkit info game.ird`
|
||||
The info can be printed to a file, e.g. `-o out.txt` or `--output=`
|
||||
The info can be formatted as a JSON with `-j` or `--json`
|
||||
|
||||
## Comparing IRDs
|
||||
|
||||
For all options, run `irdkit help diff`
|
||||
|
||||
To compare two IRDs, run `irdkit diff game1.ird game2.ird`
|
||||
The comparison can be printed to a file, e.g. `-o out.txt` or `--output=`
|
||||
|
||||
Reference in New Issue
Block a user