Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify nix install method in the README #531

Merged
merged 2 commits into from
Jul 17, 2024
Merged

Clarify nix install method in the README #531

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
903a624
Clarify nix install method in the README
jorg-vr Jul 16, 2024
64c9f76
Update README.md
jorg-vr Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,21 @@ If you use this software in research, please cite:
## Installing TESTed

TESTed is implemented in Python, but has various dependencies for its language-specific modules.
We only use the Python language module in this README, but see [dependencies.md](./dependencies.md) for an overview of dependencies for each of the supported programming languages.
See [dependencies.md](./dependencies.md) for an overview of dependencies for each of the supported programming languages.

Install [Python 3.11](https://www.python.org/downloads/) or later (including pip).
### Nix installation
The easiest way to install TESTed with all it's dependencies is using the [Nix](https://nixos.org/) package manager.
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved

Install Nix using [The Determinate Nix Installer](https://github.com/DeterminateSystems/nix-installer).
Next, [clone](https://github.com/git-guides/git-clone) the TESTed repository and open a command prompt in the cloned repository.

Then run `nix develop` to open a shell environment with all dependencies installed.
The first time you run this command, it will take a while to download and build all dependencies.

### Poetry installation
If you only need the Python language module, or want to manually install a subset of the [dependencies](./dependencies.md), you can use [poetry](https://python-poetry.org/).

Install [Python 3.12](https://www.python.org/downloads/) or later (including pip).
Next, [clone](https://github.com/git-guides/git-clone) the TESTed repository and open a command prompt in the cloned repository.
TESTed uses [poetry](https://python-poetry.org/) to manage its Python dependencies.
Now you can run the following commands to install them:
Expand All @@ -29,8 +41,7 @@ $ pip install poetry --user
$ poetry install
```

Those using [Nix](https://nixos.org/) can use `nix develop` to get a development environment.
`nix run` will run TESTed.
Running `poetry shell` will open a shell environment with all python dependencies installed.

## Running TESTed

Expand Down