aboutsummaryrefslogtreecommitdiffstats
path: root/meson/docs/markdown/index.md
diff options
context:
space:
mode:
authorAngelos Mouzakitis <a.mouzakitis@virtualopensystems.com>2023-10-10 14:33:42 +0000
committerAngelos Mouzakitis <a.mouzakitis@virtualopensystems.com>2023-10-10 14:33:42 +0000
commitaf1a266670d040d2f4083ff309d732d648afba2a (patch)
tree2fc46203448ddcc6f81546d379abfaeb323575e9 /meson/docs/markdown/index.md
parente02cda008591317b1625707ff8e115a4841aa889 (diff)
Add submodule dependency filesHEADmaster
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'meson/docs/markdown/index.md')
-rw-r--r--meson/docs/markdown/index.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/meson/docs/markdown/index.md b/meson/docs/markdown/index.md
new file mode 100644
index 000000000..14bdfbed8
--- /dev/null
+++ b/meson/docs/markdown/index.md
@@ -0,0 +1,60 @@
+---
+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, macOS, Windows, GCC, Clang, Visual Studio and others
+* supported languages include C, C++, D, 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!
+
+## Quickstart for beginners
+
+Are you an absolute beginner when it comes to programming? No worries,
+read [this beginner guide](SimpleStart.md) to get started.
+
+## Community
+
+There are two main methods of connecting with other Meson
+developers. The easiest way for most people is a web chat. The channel
+to use is `#mesonbuild` either via Matrix ([web
+interface](https://app.element.io/#/room/#mesonbuild:matrix.org)) or
+[OFTC IRC](https://www.oftc.net/).
+
+The second one is the mailing list, which is hosted at
+[Google Groups](https://groups.google.com/forum/#!forum/mesonbuild).
+
+### [Projects using Meson](Users.md)
+
+Many projects are using Meson and they're
+a great resource for learning what to (and what not to!) do when
+converting existing projects to Meson.
+
+[A short list of Meson users can be found here](Users.md)
+but there are many more. We would love to hear about your success
+stories too and how things could be improved too!
+
+## Development
+
+All development on Meson is done on the [GitHub
+project](https://github.com/mesonbuild/meson). Instructions for
+contributing can be found on the [contribution page](Contributing.md).
+
+
+You do not need to sign a CLA to contribute to Meson.