From: Jean Privat Date: Fri, 12 Jul 2019 19:09:34 +0000 (-0400) Subject: README: update the state of requirements X-Git-Url: http://nitlanguage.org README: update the state of requirements Signed-off-by: Jean Privat --- diff --git a/README.md b/README.md index 2679f4d..e499bbb 100644 --- a/README.md +++ b/README.md @@ -19,20 +19,19 @@ Requirements: * pkg-config http://www.freedesktop.org/wiki/Software/pkg-config/ * ccache http://ccache.samba.org/ to improve recompilation * libgc-dev http://hboehm.info/gc/ - * graphviz http://www.graphviz.org/ to enable graphs with the nitdoc tool * libunwind http://nongnu.org/libunwind Those are available in most Linux distributions - $ sudo apt-get install build-essential ccache libgc-dev graphviz libunwind-dev pkg-config + $ sudo apt-get install build-essential ccache libgc-dev libunwind-dev pkg-config and on OS X using brew - $ brew install ccache bdw-gc graphviz libunwind-headers pkgconfig + $ brew install ccache bdw-gc libunwind-headers pkgconfig or with MacPorts - $ sudo port install ccache boehmgc graphviz libunwind-headers pkgconfig + $ sudo port install ccache boehmgc libunwind-headers pkgconfig Important files and directories: @@ -65,6 +64,20 @@ To have your environment automatically configured at login, just source it with $ . misc/nit_env.sh install + +More tools: + +Additional tools can also be compiled but require more dependencies. + + * graphviz http://www.graphviz.org/ to enable graphs with the nitdoc tool + * libcurl https://curl.haxx.se/libcurl/ for the nit package manager nitpm + * libevent https://libevent.org/ for the nit documentation server nitweb + * libmongoc http://mongoc.org/ also for nitweb + + $ sudo apt-get install graphviz libcurl4-openssl-dev libevent-dev libmongoc-dev + $ make more + + Contributing: To contribute to Nit, please see [CONTRIBUTING](CONTRIBUTING.md).