From 82c8550fb6f124835726789b13bbc37746e16bcf Mon Sep 17 00:00:00 2001 From: Jussi Pakkanen Date: Fri, 22 Dec 2017 21:51:03 +0200 Subject: Added documentation for project templates. --- docs/markdown/Project-templates.md | 28 ++++++++++++++++++++++++++++ docs/sitemap.txt | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/markdown/Project-templates.md (limited to 'docs') diff --git a/docs/markdown/Project-templates.md b/docs/markdown/Project-templates.md new file mode 100644 index 0000000..dd86e13 --- /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 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 -- cgit v1.1 From 4a189cf8c53e22b747521cae93c18cac3a45cc5a Mon Sep 17 00:00:00 2001 From: Jussi Pakkanen Date: Thu, 28 Dec 2017 00:01:31 +0200 Subject: Add unit test that checks that the sample projects compile. --- docs/markdown/Project-templates.md | 4 +++- docs/markdown/snippets/templates.md | 8 ++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 docs/markdown/snippets/templates.md (limited to 'docs') diff --git a/docs/markdown/Project-templates.md b/docs/markdown/Project-templates.md index dd86e13..d8459c6 100644 --- a/docs/markdown/Project-templates.md +++ b/docs/markdown/Project-templates.md @@ -2,7 +2,7 @@ short-description: Project templates ... -# Project templates (available since 0.45.0) +# 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 @@ -26,3 +26,5 @@ $ 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 +``` -- cgit v1.1