* 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/
+ * libgc-dev http://hboehm.info/gc/
* graphviz http://www.graphviz.org/ to enable graphs with the nitdoc tool
* libunwind http://nongnu.org/libunwind
$ sudo apt-get install build-essential ccache libgc-dev graphviz libunwind-dev pkg-config
+and on OS X using brew
+
+ $ brew install ccache bdw-gc graphviz libunwind-headers pkgconfig
+
+or with MacPorts
+
+ $ sudo port install ccache boehmgc graphviz libunwind-headers pkgconfig
+
Important files and directories:
* benchmarks/ Script to bench the compilers
$ bin/nitc examples/hello_world.nit
$ ./hello_world
-You can put the `bin/` directory in your PATH
+You can source `misc/nit_env.sh` to setup your environment like PATH, MANPATH and bash completion.
+To have your environment automatically configured at login, just source it with `install` as argument.
+
+ $ . misc/nit_env.sh install
+
+Contributing:
+
+To contribute to Nit, please see [CONTRIBUTING](CONTRIBUTING.md).
-Using bash completion with Nit tools:
+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`).
- $ echo source /absolute/path/to/misc/bash_completion/nit >> ~/.bash_completion
- $ source ~/.bash_completion
+Information, contacts and help:
-More information: <http://www.nitlanguage.org>
+* Website <http://www.nitlanguage.org>
+* Issues <https://github.com/nitlang/nit/issues>
+* Chatroom <https://gitter.im/nitlang/nit>