update README

This commit is contained in:
Denis Lehmann 2021-03-11 10:30:50 +01:00
parent e26c68f285
commit eb17946c21
2 changed files with 23 additions and 5 deletions

View file

@ -1,5 +0,0 @@
# nix_virtualenvs
This is a repository for different virtual environments, which can be used with the **Nix** package manager.
Just copy the content of the desired folder to your project, add your required packages to the `*.txt` file and run `nix-shell`.

23
README.org Normal file
View file

@ -0,0 +1,23 @@
* nix_virtualenvs
This is a set of various virtual 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.
Please check below how the virtual environments work and how to add environment specific packages.
If you need more Nix packages in your environent, enhance the list ~buildInputs~ in the file =shell.nix=.
** node_environment
1. Create a directory =.npm=
2. If the file =global_packages.txt= is present, install the packages via *npm* globally in the =.npm= directory
3. Run ~npm install~ if a file =package.json= is present
4. Add the =.npm= directory to the ~$PATH~ variable
** python_environment
1. Create a new python virtualenv in the folder =.venv=
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