README: update
[nit.git] / README
1 Nit is a statically typed object-oriented programming language.
2 The goal of Nit is to propose a statically typed programming language where structure is not a pain.
3
4 Nit has a simple straightforward style and can usually be picked up quickly, particularly by anyone who has programmed before.
5 While object-oriented, it allows procedural styles.
6
7 The Nit Compiler (nitc) produces efficient machine language binaries.
8
9 Some Nit features:
10  * Pure Object-Oriented.
11  * Multiple Inheritance.
12  * Realist typing policy.
13  * Light and clear syntax.
14
15
16 Requirement:
17
18         * gcc           http://gcc.gnu.org/
19         * ccache        http://ccache.samba.org/        to improve recompilation
20
21 Optionals tools:
22
23         * dot           http://www.graphviz.org/        to enable graphes with the nitdoc tool
24
25 Important files and directory:
26
27         benchmarks/     Script to bench the compilers
28         bin/            The Nit tools
29         bin/nitc        The Nit compiler
30         bin/nitg        The new Nit compiler
31         bin/nit         The Nit interpreter
32         bin/nitdoc      The Nit autodoc
33         c_src/          C code of nitc (needed to bootstrap)
34         clib/           C code needed by nitc to compile programs
35         Changelog       List of change between versions
36         contrib/        Various Nit programs (may or may not be useful)
37         doc/            Documentation
38         examples/       Program examples written in Nit
39         LICENCE         License of the software
40         misc/           Some additional file for commons text editors and tools
41         tests/          Non-regression test-suite
42         lib/            Nit standard library
43         Makefile        Bootstrap the Nit tools
44         NOTICE          List of the authors
45         README          This file
46         src/            The Nit tool sources (written in Nit)
47
48
49 How to start:
50
51  * $ make
52  * $ bin/nitc examples/hello_world.nit
53  * $ ./hello_world
54
55
56 More information:
57
58         http://www.nitlanguage.org
59