From a0b7bb466fe96fb300bb59d4cc71068f7b0d53be Mon Sep 17 00:00:00 2001 From: pyrotek45 <51059135+pyrotek45@users.noreply.github.com> Date: Wed, 15 May 2024 17:59:43 -0400 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6abf620b..1a990035 100644 --- a/README.md +++ b/README.md @@ -53,18 +53,18 @@ make ``` > Besides developer options, you migth want to check *USE_DOUBLE*, in util/config.mk, which set the floating point size (float or double). -> Note that the option you choose must match how you built your soundpipe library (more on soundpipe later). +> Note that the option you choose must match how you built your soundpipe library (more on soundpipe later). ## Nix - Install To get started with Gwion, use the provided default.nix file. - Navigate to the main Gwion repository. - Enter the following command: +Navigate to the main Gwion repository. +Enter the following command: - ```bash - nix-env -if default.nix - ``` +```bash +nix-env -if default.nix +``` This should install Gwion. @@ -74,6 +74,14 @@ Afterwards, you can run the Gwion Interpreter with the following command: gwion ``` +The default.nix file includes a fixed commit hash. If you prefer to utilize the latest version, you'll need to update the commit hash accordingly. Here's how: + +- Go to the Gwion repository on GitHub. +- Locate the commit hash of the latest version you want to use. +- Update the commit hash in the default.nix file to match the desired version. +- Save the changes. +- Re-run the installation command mentioned earlier to install the updated version of Gwion. + ## Executing your first code (hello_world.gw): This assumes you have successfully compiled gwion. To build follow [these steps](#build) . To check, if the build was successfully run -- 2.43.0