From c1e517f5cf69124d5fd753cf656045303febcccb Mon Sep 17 00:00:00 2001 From: Denis Lehmann Date: Thu, 11 Mar 2021 18:25:20 +0100 Subject: [PATCH] update README --- README.org | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.org b/README.org index 47d8e80..931ba60 100644 --- a/README.org +++ b/README.org @@ -1,6 +1,6 @@ -* nix_virtualenvs +* nix_environments - This is a set of various virtual environments which can be used with the *Nix* package manager. + This is a set of various environments which can be used with the *Nix* package manager. Copy the =shell.nix= file from the desired folder into your project and run ~nix-shell~. This will drop you into a virtual environment with all requirements fulfilled. @@ -8,7 +8,9 @@ If you need more Nix packages in your environent, enhance the list ~buildInputs~ in the file =shell.nix=. -** node_environment +** node + + This environment does the following: 1. Create a directory =.npm/bin= if not existent 2. Add the =.npm/bin= directory to the ~$PATH~ variable @@ -16,13 +18,17 @@ 4. If the file =global_packages.txt= is present, install the packages via npm into the =.npm= directory 5. Run ~npm install~ if a file =package.json= is present -** python_environment +** python + + This environment does the following: 1. Create a new python virtualenv in the folder =.venv= if not existent 2. Source the virtual environment 3. Upgrade pip to the latest version 4. If present, install the packages from the file =requirements.txt= via pip -** rust_environment +** rust + + This environment does the following: 1. Run ~cargo build~ if =Cargo.toml= is present