From 2dc41ae8758aff9096e01150befe1a636c5b8572 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Warcho=C5=82?= <61014013+war-in@users.noreply.github.com> Date: Wed, 17 Jan 2024 14:02:43 +0100 Subject: [PATCH] Add installation instructions (#14) --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 0144466..b5530a1 100644 --- a/README.md +++ b/README.md @@ -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: