summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2017-12-22 21:51:03 +0200
committerJussi Pakkanen <jpakkane@gmail.com>2017-12-31 23:18:08 +0200
commit82c8550fb6f124835726789b13bbc37746e16bcf (patch)
tree0b677a361bd7549fed943b88d87c5acb310a2e95
parent3cc1462dd24f373ec4cf047564ff0d77f4b6d3e9 (diff)
downloadmeson-82c8550fb6f124835726789b13bbc37746e16bcf.tar.gz
Added documentation for project templates.
-rw-r--r--docs/markdown/Project-templates.md28
-rw-r--r--docs/sitemap.txt1
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/markdown/Project-templates.md b/docs/markdown/Project-templates.md
new file mode 100644
index 000000000..dd86e13db
--- /dev/null
+++ b/docs/markdown/Project-templates.md
@@ -0,0 +1,28 @@
+---
+short-description: Project templates
+...
+
+# Project templates (available since 0.45.0)
+
+To make it easier for new developers to start working, Meson ships a
+tool to generate the basic setup of different kinds of projects. This
+functionality can be accessed with the `meson init` command. A typical
+project setup would go like this:
+
+```console
+$ mkdir project_name
+$ cd project_name
+$ meson init --language=c --name=myproject --version=0.1
+```
+
+This would create the build definitions for a helloworld type
+project. The result can be compiled as usual. For example compiling it
+with Ninja could be done like this:
+
+```
+$ meson builddir
+$ ninja -C builddir
+```
+
+The generator has many different projects and settings. They can all
+be listed by invoking the command `meson test --help`.
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index b7ee136ca..87a5eb51f 100644
--- a/docs/sitemap.txt
+++ b/docs/sitemap.txt
@@ -48,6 +48,7 @@ index.md
Creating-releases.md
Creating-OSX-packages.md
Creating-Linux-binaries.md
+ Project-templates.md
Reference-manual.md
Reference-tables.md
FAQ.md