Skip to content

Commit

Permalink
Update README to include release process
Browse files Browse the repository at this point in the history
Also add info on 'collisions' command.
  • Loading branch information
cyberrumor committed Mar 12, 2024
1 parent 96e8dab commit 529ad69
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,24 @@ echo 'PATH="$PATH:$HOME/.local/bin"' >> ~/.bashrc
PATH="$PATH:$HOME/.local/bin"
git clone https://github.com/cyberrumor/ammo
cd ammo
pip3 install --user -r requirements.txt || pip3 install --user --break-system-packages -r requirements.txt
pip3 install --user . || pip3 install --user --break-system-packages .
pip3 install --user --break-system-packages -r requirements.txt
pip3 install --user --break-system-packages .
```

You can now execute ammo with the terminal command `ammo`.

## Updating Instructions

Check the releases page for possible manual migration steps.
Releases are only published on breaking changes, and are there
for the benefit of people who don't have time to address those
changes. In general, you should be using the most recent
version of the main branch.

```sh
cd /path/to/ammo/clone/dir
git pull
pip3 install --user --force-reinstall . || pip3 install --user --break-system-packages --force-reinstall .
pip3 install --user --break-system-packages --force-reinstall .
```

## Usage Instructions
Expand All @@ -68,6 +74,7 @@ pip3 install --user --force-reinstall . || pip3 install --user --break-system-pa
| Command | Arguments | Description |
|-|-|-|
| activate | (mod\|plugin) \<index> | Enabled components will be loaded by game |
| collisions | \<index> | Show file conflicts for a mod |
| commit | | Apply pending changes |
| configure | \<index> | Configure a fomod |
| deactivate | (mod\|plugin) \<index> | Disabled components will not be loaded by game |
Expand Down

0 comments on commit 529ad69

Please sign in to comment.