Skip to content

Commit

Permalink
Add tutorial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
felix-hilden committed Sep 12, 2021
1 parent 48106a5 commit 9654811
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ or a specific configuration in more detail.
$ mold config list
$ mold config show python-library
For more details see :ref:`cli` and the list of :ref:`plugins`.
If you're new here, have a look at the :ref:`tutorial`.

Mission
-------
We aim to be the fastest and simplest way of creating
Expand Down Expand Up @@ -72,6 +75,7 @@ Seeing new tools might even spark inspiration to learn more.

release_notes
command_line_reference
tutorial
plugins

.. toctree::
Expand Down
51 changes: 51 additions & 0 deletions docs/src/tutorial.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
.. _tutorial:

Tutorial
========

Initialising projects
---------------------
Initialising a new project is the default action of Mold.
Optionally you can specify the name of the configuration to be used.
If none is specified, a dialog will determine the configuration.

.. code:: sh
$ mold
$ mold python-project
A series of dialogs follows that finalise the configuration
and provide project metadata.
Finally the files are written to a new folder in the current working directory.
See the :ref:`cli` for details and more options.

Creating configurations
-----------------------
The default configurations are meant to serve as a starting point.
It is possible to customise the tools applied to your projects.
See the :ref:`cli` for details and more options.

.. code:: sh
$ mold config new [config name]
Prefilling values
-----------------
Some project metadata doesn't really change, like email addresses or usernames.
To further reduce hassle when initialising projects,
these values can be prefilled and applied to projects automatically.
See the :ref:`cli` for details and more options.

.. code:: sh
$ mold prefill
Custom extensions
-----------------
Mold is built for modularity.
Making custom extensions, like implementing new tools and templates,
is straight forward with a builtin source code example.
See :ref:`reference` for more details.
If the tool is something that could be applicable to many users,
please open a feature request on the
`issue tracker <https://github.com/felix-hilden/mold/issues>`_!

0 comments on commit 9654811

Please sign in to comment.