-
Notifications
You must be signed in to change notification settings - Fork 2
Install
David Pochet edited this page Oct 16, 2022
·
2 revisions
nmk
can be used without being "installed" (meaning a system-level install).
There two cases:
- either you want to build an existing
nmk
project - or you want to bootstrap a new one
Each nmk
project provides a loadme.sh
script, that can be "sourced" to bootstrap everything:
- check system requirements
- create and load a python venv
- install
nmk
(and potentially other project requirements) - setup
nmk
completion
In other words, you can build a freshly cloned nmk project with these two commands:
$ source loadme.sh
$ nmk
Note for Windows users
If you plan to develop your project on Windows, you've probably installed git
. The commands above can then be executed in git-bash
terminal to create the venv.
Once this is done, if you prefer to get back to a Windows cmd
chell, you can load the venv as usual:
> venv\Scripts\activate.bat
If you want to create a new nmk
project, you can simply bootstrap it with the following commands
$ wget https://github.com/dynod/nmk/raw/main/loadme.sh
$ source loadme.sh
You'll then have to create an nmk project file.
nmk
project comes with following examples: