mirror of
https://github.com/two-torial/sp2xpatcher.git
synced 2024-09-23 18:58:26 +02:00
Update instructions
This commit is contained in:
parent
e8ca43b893
commit
3943525d47
@ -4,11 +4,18 @@
|
|||||||
|
|
||||||
## How?
|
## How?
|
||||||
|
|
||||||
**Fork** the project, **add/modify** files, propose a **Pull Request** and we'll get to it asap.
|
1. **Fork** the project if you don't already have it
|
||||||
**Important Note:** When adding a new game version, add it to the [List of supported games](SUPPORTED.md) using the existing format, we won't merge your PR until you do.
|
2. **Add/Modify/Stage/Commit** files as necessary **BUT don't Push/Sync them yet**
|
||||||
|
3. **Run** the `checks.py` script with `python checks.py`
|
||||||
|
4. If the script did anything: **Commit** its changes
|
||||||
|
5. **Push/Sync** the changes to your repo
|
||||||
|
6. **Propose a Pull Request** and we'll get to it asap
|
||||||
|
|
||||||
Once a pull request is merged, patches will be available within minutes at `https://sp2x.two-torial.xyz/`
|
Once a pull request is merged, patches will be available within minutes at `https://sp2x.two-torial.xyz/`
|
||||||
|
|
||||||
|
### /!\ Important Note
|
||||||
|
When adding a new game version, add it to the [List of supported games](SUPPORTED.md) using the existing format, we won't merge your PR until you do.
|
||||||
|
|
||||||
## JSON Naming
|
## JSON Naming
|
||||||
|
|
||||||
**Spice2x patches have one json file per game version**.
|
**Spice2x patches have one json file per game version**.
|
||||||
|
Loading…
Reference in New Issue
Block a user