2021-06-03 12:39:34 +00:00
|
|
|
# nim-workspace
|
|
|
|
|
|
|
|
|
|
A Nimble-based environment for working on one or more Status Nim projects.
|
|
|
|
|
|
2021-12-21 17:31:59 +00:00
|
|
|
## Prerequisites
|
2021-12-21 16:47:27 +00:00
|
|
|
|
2021-12-21 17:31:59 +00:00
|
|
|
Please install the standard C/C++ toolchain for your operating system
|
|
|
|
|
(e.g. `sudo apt install build-essentials`).
|
|
|
|
|
|
|
|
|
|
The scripts in this repo will automatically take care of installing the
|
|
|
|
|
right version of Nim and Nimble for you. To enable the automation, please
|
|
|
|
|
install `direnv` from your distro's package manager or by following the
|
|
|
|
|
instructions here:
|
2021-12-21 16:47:27 +00:00
|
|
|
|
|
|
|
|
https://github.com/direnv/direnv
|
|
|
|
|
|
2021-06-03 12:39:34 +00:00
|
|
|
## Commands
|
|
|
|
|
|
2021-12-21 17:31:59 +00:00
|
|
|
### `add-project <project-name>`
|
2021-06-03 12:39:34 +00:00
|
|
|
|
|
|
|
|
Clones a Status project you intend to work on. An interactive script will
|
|
|
|
|
ask you whether you also want to clone each of the transitive dependencies
|
|
|
|
|
of the project. All dependencies that were not cloned for development will
|
|
|
|
|
be installed in the Nimble cache.
|
|
|
|
|
|
|
|
|
|
Projects can be removed from the workspace by just deleting the respective
|
|
|
|
|
directory. This will result in Nimble installing the project's package in
|
|
|
|
|
the global cache during the next `nimble build`.
|
