Skip to content

Commit

Permalink
Document and Release
Browse files Browse the repository at this point in the history
  • Loading branch information
Capuccino authored Aug 6, 2018
1 parent c53eed0 commit 332a881
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A simple nifty tool to build your mod in just one go!

## How to use
## How to install

Simply `git pull` and run it. It's easy.

Expand All @@ -14,6 +14,23 @@ wget https://raw.githubusercontent.com/Sayo-nika/autobuild.sh/master/autobuild.s

````

## Using the CLI

To start the script in interactive mode, just run `./autobuild.sh`.

However, if you want to use arguments for non-interactive usage, like CIs, These are the available options

```
./autobuild.sh [-d <DIRECTORY> | -h]
Builds a mod by creating a build/ folder and compiles releases there.
When no arguments are present, the script starts in interactive mode.
However, for non-interactive usage, the following is accepted as a argument:
-d <DIRECTORY> The Directory of the mod to build.
-h Print this help dialogue.
```

## Contributing

If you think you can make this better, send us a PR! We love you.
Expand Down

0 comments on commit 332a881

Please sign in to comment.