aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2016-02-26 21:59:10 +0200
committerJussi Pakkanen <jpakkane@gmail.com>2016-02-26 21:59:10 +0200
commit06693f8d9e08068e24fd1bd771d68f23e4456b44 (patch)
treeb399a2b4ce105bbe0c005650d4cc4b37546cd84c
parentaf53c2bc3b13ba8eb7f9e8f5c3990b966c792e5d (diff)
parent41dd1e2a24ba60a8413b5cbed423181264e627b7 (diff)
downloadmeson-06693f8d9e08068e24fd1bd771d68f23e4456b44.zip
meson-06693f8d9e08068e24fd1bd771d68f23e4456b44.tar.gz
meson-06693f8d9e08068e24fd1bd771d68f23e4456b44.tar.bz2
Merge pull request #412 from lukeadams/master
Improve readme
-rw-r--r--README.md (renamed from readme.txt)36
1 files changed, 18 insertions, 18 deletions
diff --git a/readme.txt b/README.md
index 4ed822f..7b3ac20 100644
--- a/readme.txt
+++ b/README.md
@@ -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.
+####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
extracted tarball. Meson is also available from PyPi, so it can
be installed with 'pip install meson'.
-
-Running
+####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 <source directory> <build directory>
+`meson <source directory> <build directory>`
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
+`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'.
+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=/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.
-Contributing
+####Contributing
We love code contributions. See the contributing.txt file for
details.
@@ -52,7 +52,7 @@ IRC
The irc channel for Meson is #mesonbuild over at freenode.
-Further info
+####Further info
The home page of Meson can be found here: