update README

This commit is contained in:
Denis Lehmann 2021-03-11 18:25:20 +01:00
parent 0cdc75a4f0
commit c1e517f5cf

View file

@ -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~. 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. 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=. 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 1. Create a directory =.npm/bin= if not existent
2. Add the =.npm/bin= directory to the ~$PATH~ variable 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 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 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 1. Create a new python virtualenv in the folder =.venv= if not existent
2. Source the virtual environment 2. Source the virtual environment
3. Upgrade pip to the latest version 3. Upgrade pip to the latest version
4. If present, install the packages from the file =requirements.txt= via pip 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 1. Run ~cargo build~ if =Cargo.toml= is present