Skip to content

Commit 5be2b6c

Browse files
committed
Update README
1 parent a74dfac commit 5be2b6c

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Moreover, I use the following the directories that are (usually) ignored by Git:
2222

2323
### Getting started
2424

25-
First clone/fork/copy the repository.
25+
First clone/fork/copy the repository (on GitHub, you can use it as a template directly).
2626
Then, you should update:
2727

2828
- the repository name
2929
- project information in [`pyproject.toml`](pyproject.toml)
3030
- the README
3131
- the license
3232

33-
### Computational environment
33+
### Conda setup
3434

3535
To set up the environment with conda, navigate to the repository directory and run the following in the command line (specify the Python version and environment name as appropriate):
3636

@@ -47,6 +47,18 @@ $ conda env export > environment.yml
4747
$ conda create -n myenv -f environment.yml
4848
```
4949

50+
### venv setup
51+
52+
Alternatively, a virtual environment (`.venv`) can be initialised with:
53+
54+
```bash
55+
$ python -m venv .venv
56+
$ .venv/Scripts/activate
57+
$ pip install -e .
58+
```
59+
60+
And the environment can be exported with the usual `pip freeze requirements.txt`.
61+
5062
### Development environment
5163

5264
I usually work with Visual Studio code, for which various settings are already predefined.

0 commit comments

Comments
 (0)