diff --git a/README.md b/README.md new file mode 100644 index 000000000..7b3ac205e --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +

+ +

+MesonĀ® is a project to create the best possible next-generation +build system. + +####Dependencies + + - Python http://python.org (version 3.4 or newer) + - Ninja http://martine.github.com/ninja/ + + +####Installing from source +You can run Meson directly from a revision control checkout or an +extracted tarball. Meson is also available from PyPi, so it can +be installed with 'pip install meson'. + +####Running + +Meson requires that you have a source directory and a build directory +and that these two are different. In your source root must exist a file +called 'meson.build'. To generate the build system run this command: + +`meson ` + +You can omit either of the two directories, and Meson will substitute +the current directory and autodetect what you mean. This allows you to +do things like this: + +`cd source_root; mkdir build; cd build; meson ..` +`cd source_root; mkdir build; meson build` + +To compile, cd into your build directory and type `ninja`. To run unit +tests, type `ninja test`. + +Install is the same but it can take an extra argument: + +`DESTDIR=/destdir/path ninja install` + +`DESTDIR` can be omitted. If you are installing to system directories, +you may need to run this command with sudo. + + +####Contributing + +We love code contributions. See the contributing.txt file for +details. + + +IRC + +The irc channel for Meson is #mesonbuild over at freenode. + + +####Further info + +The home page of Meson can be found here: + +http://mesonbuild.com + +Meson is a registered trademark of Jussi Pakkanen