From fd56b4882531fc89f4cd4cc29016314773fd395d Mon Sep 17 00:00:00 2001 From: gingerBill Date: Sat, 1 May 2021 17:30:22 +0100 Subject: [PATCH] Add `ODIN_ROOT` information --- bin/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/bin/README.md b/bin/README.md index f58f0a482..9e35adc23 100644 --- a/bin/README.md +++ b/bin/README.md @@ -23,6 +23,7 @@ In addition, the following platform-specific steps are necessary: Then build the compiler by calling `build.bat` (Windows) or `make` (Linux/MacOS). This will automatically run the demo program if successful. -**Notes for Linux:**: The compiler currently relies on the `core` and `shared` library collection being relative to the compiler executable. Installing the compiler in the usual sense (to `/usr/local/bin` or similar) is therefore not as straight forward as you need to make sure the mentioned libraries are available. As a result, it is recommended to simply explicitly invoke the compiler with `/path/to/odin` in your preferred build system, or add `/path/to/odin` to `$PATH`. +**Notes for \*Nix Systems:**: The compiler currently relies on the `core` and `shared` library collection being relative to the compiler executable, by default. Installing the compiler in the usual sense (to `/usr/local/bin` or similar) is therefore not as straight forward as you need to make sure the mentioned libraries are available. As a result, it is recommended to either simply explicitly invoke the compiler with `/path/to/odin` in your preferred build system, or `set ODIN_ROOT=/path/to/odin_root`. + Please read the [Getting Started Guide](https://github.com/odin-lang/Odin/wiki#getting-started-with-odin) for more information.