aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Project-templates.md30
-rw-r--r--docs/markdown/snippets/templates.md8
-rw-r--r--docs/sitemap.txt1
3 files changed, 39 insertions, 0 deletions
diff --git a/docs/markdown/Project-templates.md b/docs/markdown/Project-templates.md
new file mode 100644
index 0000000..d8459c6
--- /dev/null
+++ b/docs/markdown/Project-templates.md
@@ -0,0 +1,30 @@
+---
+short-description: Project templates
+...
+
+# Project templates
+
+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`.
+
+This feature is available since Meson version 0.45.0.
diff --git a/docs/markdown/snippets/templates.md b/docs/markdown/snippets/templates.md
new file mode 100644
index 0000000..6f0474d
--- /dev/null
+++ b/docs/markdown/snippets/templates.md
@@ -0,0 +1,8 @@
+## Project templates
+
+Meson ships with predefined project templates. To start a new project from
+scratch, simply go to an empty directory and type:
+
+```meson
+meson init --name=myproject --type=executable --language=c
+```
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index b7ee136..87a5eb5 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