status-im
/
nim-workspace
mirror of https://github.com/status-im/nim-workspace.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Some tweaks to the README

This commit is contained in:
Zahary Karadjov 2021-12-21 19:31:59 +02:00
parent e044a3499d
commit f80cbf0ee2
No known key found for this signature in database
GPG Key ID: C8936F8A3073D609
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,17 +2,21 @@
A Nimble-based environment for working on one or more Status Nim projects.
## Pre-requisites
## Prerequisites
The scripts in this repo will automatically manage your Nim and Nimble versions.
To enable the automation, please install `direnv` from your distro's package
manager or by following the instructions here:
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:
https://github.com/direnv/direnv
## Commands
### `./add-project <project-name>`
### `add-project <project-name>`
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