X-Git-Url: http://nitlanguage.org diff --git a/README b/README index 3c91315..3ee0c42 100644 --- a/README +++ b/README @@ -7,6 +7,7 @@ While object-oriented, it allows procedural styles. The Nit Compiler (nitc) produces efficient machine language binaries. Some Nit features: + * Pure Object-Oriented. * Multiple Inheritance. * Realist typing policy. @@ -14,37 +15,53 @@ Some Nit features: Requirement: - + * gcc http://gcc.gnu.org/ + * 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 graphes 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 pkg-config Important files and directory: + benchmarks/ Script to bench the compilers bin/ The Nit tools bin/nitc The Nit compiler + bin/nit The Nit interpreter bin/nitdoc The Nit autodoc - BUGS Known big usability bugs c_src/ C code of nitc (needed to bootstrap) clib/ C code needed by nitc to compile programs Changelog List of change between versions + contrib/ Various Nit programs (may or may not be useful) doc/ Documentation examples/ Program examples written in Nit LICENCE License of the software + misc/ Some additional file for commons text editors and tools tests/ Non-regression test-suite lib/ Nit standard library Makefile Bootstrap the Nit tools NOTICE List of the authors README This file src/ The Nit tool sources (written in Nit) - TODO What next features are planed How to start: - * $ make - * $ bin/nitc examples/hello_world.nit - * $ ./hello_world + $ make + $ bin/nitc examples/hello_world.nit + $ ./hello_world + +You can put the `bin/` directoty in your PATH + +Using bash completion with Nit tools: + $ echo source /absolute/path/to/misc/bash_completion/nit >> ~/.bash_completion + $ source ~/.bash_completion More information: