Merge pull request #412 from lukeadams/master

Improve readme
This commit is contained in:
Jussi Pakkanen 2016-02-26 21:59:10 +02:00
commit 06693f8d9e
1 changed files with 18 additions and 18 deletions

View File

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