aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/index.md
diff options
context:
space:
mode:
authorThibault Saunier <thibault.saunier@osg.samsung.com>2017-03-29 15:03:43 -0300
committerJussi Pakkanen <jpakkane@gmail.com>2017-04-26 17:56:33 +0300
commitb371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f (patch)
tree6e1a3c34b1a85479d3b9f42ccd071096e637929b /docs/markdown/index.md
parent7dc747ea54480c452b913e4bfe682ec67061c9bf (diff)
downloadmeson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.zip
meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.tar.gz
meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.tar.bz2
docs: Import the website and wiki and build with hotdoc
This allows us to more easily have the documentation in sync with the source code as people will have to document new features etc right at the time where they implement it.
Diffstat (limited to 'docs/markdown/index.md')
-rw-r--r--docs/markdown/index.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/markdown/index.md b/docs/markdown/index.md
new file mode 100644
index 0000000..63bfd55
--- /dev/null
+++ b/docs/markdown/index.md
@@ -0,0 +1,33 @@
+---
+render-subpages: false
+...
+
+# The Meson Build system
+
+## Overview
+
+Meson is an open source build system meant to be both extremely fast, and, even more importantly, as user friendly as possible.
+
+The main design point of Meson is that every moment a developer spends writing or debugging build definitions is a second wasted. So is every second spent waiting for the build system to actually start compiling code.
+
+## Features
+
+* multiplatform support for Linux, OSX, Windows, Gcc, Clang, Visual Studio and others
+* supported languages include C, C++, Fortran, Java, Rust
+* build definitions in a very readable and user friendly non-turing complete DSL
+* cross compilation for many operating systems as well as bare metal
+* optimized for extremely fast full and incremental builds without sacrificing correctness
+* built-in multiplatform dependency provider that works together with distro packages
+* fun!
+
+## Community
+
+There are two main methods of connecting with other Meson developers. The first one is the mailing list, which is hosted at [Google Groups](https://groups.google.com/forum/#!forum/mesonbuild).
+
+The second way is via IRC. The channel to use is <tt>#mesonbuild</tt> at [Freenode](https://freenode.net/).
+
+## Development
+
+All development on Meson is done on [Github project](https://github.com/mesonbuild/meson). For further info look into the <tt>contributing.txt</tt> file that comes with Meson's source checkout.
+
+You do not need to sign a CLA to contribute to Meson.