Skip to content

Commit

Permalink
Add installation instructions (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
war-in authored Jan 17, 2024
1 parent c922b06 commit 2dc41ae
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,21 @@ Universal-Sierra-Compiler is the tool for Sierra compilation. It compiles any ev
| 1.0.0 |
| 0.1.0 |

## Installation

To install the binary on your PATH run the following line

```shell
curl -L https://raw.githubusercontent.com/software-mansion/universal-sierra-compiler/master/scripts/install.sh | sh

...
universal-sierra-compiler (v1.0.0) has been installed successfully.
```

> 📝 **Note**
>
> If the script can't add installed binary to the PATH, it will print the instructions about adding it manually.
## Usage

To use the tool, just pass a path to a file with Sierra in json format:
Expand Down

0 comments on commit 2dc41ae

Please sign in to comment.