Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Centri3 committed May 4, 2023
1 parent 80d4fb6 commit 602655b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ A tool to ease creation of gas giants in Universe Sandbox

## Usage

**For a more in-depth explanation, run `us-ggg --help`, `us-ggg convert --help`, etc.**
**For a more in-depth explanation, run `./us-ggg --help`, `./us-ggg convert --help`, etc.**

To check if an image is a valid gas giant, simply run: `us-ggg <IMAGE> valid`.
To check if an image is a valid gas giant, simply run: `./us-ggg <IMAGE> valid`.

To convert an image into a gas giant, simply run: `us-ggg convert <IMAGE> convert <OLD_GIANT> [NEW_GIANT] [POS]`
To convert an image into a gas giant, simply run: `./us-ggg convert <IMAGE> convert <OLD_GIANT> [NEW_GIANT] [POS]`

Where `<OLD_GIANT>` is the path to the .ubox you wish to use (the object), you can find these in either:

Expand All @@ -36,6 +36,8 @@ Simply extract the archive in releases corresponding to your OS.
* x86_64-pc-windows-gnu - Windows
* x86_64-unknown-linux-gnu - Linux

On Unix-like systems, you may need to do some extra setup; run `chmod +x us-ggg` from your terminal while in its directory. This will give it executable permission. You should also be able to do this from your file explorer.

## License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Expand Down

0 comments on commit 602655b

Please sign in to comment.