openium/resgen.swift
1
0
Fork 0
Code Pull Requests 1 Releases 7 Activity

Update Readme to add install/uninstall steps

Browse Source
This commit is contained in:
Thibaut Schmitt 2022-11-07 11:15:38 +01:00
parent 7d3652f1f9
commit a7a850799d
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -270,12 +270,22 @@ swift run -c release ResgenSwift generate path/to/configuration.yml --project-di
> ⚠️ Every path in `configuration.yml` will be prepended by content of `--project-directory` if they are relative path (not starting with `/`)
## Installation
## Binary usage
Simple run `./install.sh`. Binary will be install in `/usr/local/bin`. Then, use ResgenSwift like any other command:
### Installation
Example:
Run `make install`. Binary will be install in `/usr/local/bin`.
Usage:
```sh
ResgenSwift generate path/to/configuration.yml --project-directory ${PROJECT_DIR}
resgen-swift generate path/to/configuration.yml --project-directory ${PROJECT_DIR}
```
### Man page
Commands parameters and details can be find by running `resgen-swift --help`. If you prefer, a man page is also available. Run `man resgen-swift`. Man page is installed on `make install` but you can install manually by running `make create-and-install-man-file`.
### Uninstallation
To uninstall ResgenSwift: `make uninstall`.