Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rnixx committed Mar 12, 2024
1 parent 350092f commit 5af3d81
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/source/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand All @@ -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).


Expand Down
2 changes: 1 addition & 1 deletion docs/source/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 5af3d81

Please sign in to comment.