Skip to content

Commit

Permalink
boostrap -> init
Browse files Browse the repository at this point in the history
Renamed script
Updated readme
  • Loading branch information
ColmBhandal committed Sep 5, 2023
1 parent 7ff5838 commit eab42b8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
File renamed without changes.
8 changes: 4 additions & 4 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Before you begin, ensure you have the following:
* A GitHub repository where you want to host your documentation. The recommended approach is to host the documentation alongside your code in a `docs` folder. But a standalone documentation repository is also an option.
* Git and Bash installed on your system.

Bootstrap your documentation repository
Initialise your documentation repository
---------------------------------------

Bootstrap your repository by following these steps:
Initialise your repository by following these steps:

* Copy ``bootstrap.sh`` to your repository's root directory.
* Run the script: ``./bootstrap.sh``
* Copy ``init.sh`` to your repository's root directory.
* Run the script: ``./init.sh``
* Enter the installation directory when prompted. For standalone repositories, enter ".". For documentation alongside code, enter the folder where your documentation are e.g. "docs".

This Bash script does the following:
Expand Down

0 comments on commit eab42b8

Please sign in to comment.