From 5af3d816ebf46289900fa9d7f1cbc766677a8af3 Mon Sep 17 00:00:00 2001 From: Robert Niederreiter Date: Tue, 12 Mar 2024 12:58:51 +0100 Subject: [PATCH] Update docs --- docs/source/getting-started.md | 6 +++--- docs/source/templates.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/getting-started.md b/docs/source/getting-started.md index 889b629..907eb25 100644 --- a/docs/source/getting-started.md +++ b/docs/source/getting-started.md @@ -37,6 +37,8 @@ If in doubt select the `core` topic and then just hit {kbd}`Return` until done. This creates an empty `mx.ini` (only if it does not exist already) and a `Makefile`. +To update an existing Makefile without beeing prompted interactive, run `mxmake update`. + ## How to change the settings The `Makefile` consists of three sections: @@ -46,7 +48,7 @@ The `Makefile` consists of three sections: 1. Makefile logic (do not edit) The header is not intended for editing, thus it does not cause any harm by adding or removing domains here. -It is considered during the execution of `mxmake init`. +It is considered during the execution of `mxmake init` respective `mxmake update`. Added or removed topics are checked or unchecked accordingly on the next run. The settings section is where customization is happening. @@ -56,8 +58,6 @@ Thus they are often prefixed. Each setting provides a description and an optional default value. -To update the Makefile without beeing prompted interactive, run `mxmake update`. - For details read the chapter [on topics and it's domains](topics-and-domains). diff --git a/docs/source/templates.md b/docs/source/templates.md index 13e1e25..f513a83 100644 --- a/docs/source/templates.md +++ b/docs/source/templates.md @@ -8,7 +8,7 @@ It is used for general purpose internal file generation and also can be used for ## Internal templates -Internally it is used to generate base files on `mxmake init`. +Internally it is used to generate base files on `mxmake init` respective `mxmake update`. General templates, not attached to any domain: