Skip to content

Commit

Permalink
Explain the installation in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
behrmann committed Aug 8, 2020
1 parent 81fe525 commit 94917fd
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,28 @@ bells and whistles.
For a longer description and available features and options, see the
[man page](mkosi.md).

# Installation

Installing `mkosi` is easy, as it has no runtime dependencies.

If you just want the current master branch you can run
```shell
python3 -m pip install --user git+https://github.com/systemd/mkosi.git
```

If you want to hack on mkosi do
```shell
# clone either this repository or your fork of it
git clone https://github.com/systemd/mkosi/
cd mkosi
python3 -m pip install --user --editable .
```
This will install mkosi in editable mode to `~/.local/bin/mkosi`, allowing you
to use your own changes right away.

For development you will also need [mypy](https://github.com/python/mypy) and
[pytest](https://github.com/pytest-dev/pytest).

# References

* [Primary mkosi git repository on GitHub](https://github.com/systemd/mkosi/)
Expand Down

0 comments on commit 94917fd

Please sign in to comment.