Skip to content

Commit

Permalink
chore(docs): small updates in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeertmans committed Feb 1, 2024
1 parent 88ca225 commit dd17871
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,22 +45,16 @@ To run build this package locally, you need:

You can build the project locally using:

```
```bash
pdm install
```

If you need to install development dependencies, we recommend running:

```
pdm install -G:all
```

### Documentation

To generate the documentation, you first need to install an IPython kernel named
`DiffeRT`:

```
```bash
pdm run ipython kernel install --user --name=DiffeRT
```

Expand All @@ -73,7 +67,7 @@ nb_kernel_rgx_aliases = {".*": "DiffeRT"}

Then, you can build the docs with:

```
```bash
cd docs
pdm run make html
```
Expand All @@ -88,27 +82,27 @@ Both Rust and Python codebases have their own tests and benchmarks.

You can very easily test you code using Cargo:

```
```bash
cargo test
```

or benchmark it:

```
```bash
cargo bench
```

#### Testing Python code

in the same way, you can very test you code with Pytest:

```
```bash
pdm run pytest
```

or benchmark it:

```
```bash
pdm run pytest --benchmark-only
```

Expand Down

0 comments on commit dd17871

Please sign in to comment.