Skip to content

Commit

Permalink
Some doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Wim-De-Clercq committed Jun 27, 2024
1 parent 8e6e139 commit 99af800
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
6 changes: 6 additions & 0 deletions cookiecutters/demo/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ Requirements
Usage
-----

#. Use cookiecutter to generate the demo project

.. code-block:: bash
$ cookiecutter gh:OnroerendErfgoed/atramhasis --directory cookiecutters/demo
#. Create a virtual environment and install requirements

.. code-block:: bash
Expand Down
6 changes: 6 additions & 0 deletions cookiecutters/scaffold/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ Requirements
Usage
-----

#. Use cookiecutter to generate the scaffold project

.. code-block:: bash
$ cookiecutter gh:OnroerendErfgoed/atramhasis --directory cookiecutters/scaffold
#. Create a virtual environment and install requirements

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/source/customisation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ instance with only these default settings.
Creating your own project
=========================

Follow the README at `atramhasis_scaffold_cookiecutter <https://github.com/OnroerendErfgoed/atramhasis_scaffold_cookiecutter>`_
Follow the README at `atramhasis scaffold cookiecutter <https://github.com/OnroerendErfgoed/atramhasis/tree/develop/cookiecutters/scaffold/README.rst>`_

This gives you a clean slate to start your customisations on.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/demo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Once cookiecutter is installed, you use it to generate the demo site.

.. code-block:: bash
$ cookiecutter gh:OnroerendErfgoed/atramhasis_demo_cookiecutter
$ cookiecutter gh:OnroerendErfgoed/atramhasis --directory cookiecutters/demo
Running this command will ask a few questions. Just accept the default answers,
unless you want to give your project a different name. After the
Expand Down

0 comments on commit 99af800

Please sign in to comment.