README.md

   1 Nit is an expressive language with a script-like syntax, a friendly type-system and aims at elegance, simplicity and intuitiveness.
   2
   3 Nit has a simple straightforward style and can usually be picked up quickly, particularly by anyone who has programmed before.
   4 While object-oriented, it allows procedural styles.
   5
   6 The Nit Compiler (nitc) produces efficient machine language binaries.
   7
   8 Some Nit features:
   9
  10  * Pure Object-Oriented.
  11  * Multiple Inheritance.
  12  * Realist typing policy.
  13  * Light and clear syntax.
  14
  15
  16 Requirements:
  17
  18  * gcc          http://gcc.gnu.org/ (or a compatible C compiler)
  19  * pkg-config   http://www.freedesktop.org/wiki/Software/pkg-config/
  20  * ccache       http://ccache.samba.org/        to improve recompilation
  21  * libgc-dev    http://www.hpl.hp.com/personal/Hans_Boehm/gc/
  22  * graphviz     http://www.graphviz.org/        to enable graphs with the nitdoc tool
  23  * libunwind    http://nongnu.org/libunwind
  24
  25 Those are available in most Linux distributions
  26
  27     $ sudo apt-get install build-essential ccache libgc-dev graphviz libunwind-dev pkg-config
  28
  29 and on OS X using brew
  30
  31     $ brew install ccache bdw-gc graphviz libunwind-headers pkgconfig
  32
  33 or with MacPorts
  34
  35     $ sudo port install ccache boehmgc graphviz libunwind-headers pkgconfig
  36
  37 Important files and directories:
  38
  39  * benchmarks/  Script to bench the compilers
  40  * bin/         The Nit tools
  41  * c_src/       C code of nitc (needed to bootstrap)
  42  * clib/        C code needed by nitc to compile programs
  43  * contrib/     Various Nit programs (may or may not be useful)
  44  * doc/         Documentation
  45  * examples/    Program examples written in Nit
  46  * lib/         Nit standard library
  47  * LICENCE      License of the software
  48  * Makefile     Bootstrap the Nit tools
  49  * misc/        Some additional files for commons text editors and tools
  50  * NOTICE.md    List of the authors
  51  * README       This file
  52  * share/       Common resources used by tools
  53  * src/         The Nit tool sources (written in Nit)
  54  * tests/       Non-regression test-suite
  55
  56
  57 How to start:
  58
  59     $ make
  60     $ bin/nitc examples/hello_world.nit
  61     $ ./hello_world
  62
  63 You can source `misc/nit_env.sh` to setup your environment like PATH, MANPATH and bash completion.
  64 To have your environment automatically configured at login, just source it with `install` as argument.
  65
  66     $ . misc/nit_env.sh install
  67
  68
  69 Information, contacts and help:
  70
  71 * Website <http://www.nitlanguage.org>
  72 * Issues <https://github.com/nitlang/nit/issues>
  73 * Chatroom <https://gitter.im/nitlang/nit>