X-Git-Url: http://nitlanguage.org diff --git a/README.md b/README.md index d84731a..ddd682a 100644 --- a/README.md +++ b/README.md @@ -18,21 +18,20 @@ Requirements: * gcc http://gcc.gnu.org/ (or a compatible C compiler) * pkg-config http://www.freedesktop.org/wiki/Software/pkg-config/ * ccache http://ccache.samba.org/ to improve recompilation - * libgc-dev http://www.hpl.hp.com/personal/Hans_Boehm/gc/ - * graphviz http://www.graphviz.org/ to enable graphs with the nitdoc tool + * libgc-dev http://hboehm.info/gc/ * 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: @@ -46,7 +45,7 @@ Important files and directories: * lib/ Nit standard library * LICENCE License of the software * Makefile Bootstrap the Nit tools - * misc/ Some additional files for commons text editors and tools + * misc/ Some additional files for common text editors and tools * NOTICE.md List of the authors * README This file * share/ Common resources used by tools @@ -66,6 +65,25 @@ 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). + +The best way to ask the team for advice, submit bugs or request features, is through the use of Github issues, using the appropriate tag (`forum`, `feature-request`, `bug`). + Information, contacts and help: * Website