update README
[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
20
21 Important files and directory:
22
23         bin/            The Nit tools
24         bin/nitc        The Nit compiler
25         bin/nitdoc      The Nit autodoc
26         BUGS            Known big usability bugs
27         c_src/          C code of nitc (needed to bootstrap)
28         clib/           C code needed by nitc to compile programs
29         Changelog       List of change between versions
30         doc/            Documentation
31         examples/       Program examples written in Nit
32         LICENCE         License of the software
33         misc/           Some additional file for commons text editors and tools
34         tests/          Non-regression test-suite
35         lib/            Nit standard library
36         Makefile        Bootstrap the Nit tools
37         NOTICE          List of the authors
38         README          This file
39         src/            The Nit tool sources (written in Nit)
40         TODO            What next features are planed
41
42
43 How to start:
44
45  * $ make
46  * $ bin/nitc examples/hello_world.nit
47  * $ ./hello_world
48
49
50 More information:
51
52         http://www.nitlanguage.org
53