Skip to content

Commit

Permalink
docs: reorder steps
Browse files Browse the repository at this point in the history
  • Loading branch information
yoctoyotta1024 committed Aug 30, 2024
1 parent 76eece6 commit ac8820d
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions docs/source/usage/getstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,32 +38,34 @@ Necessary first steps:
#. Create an empty GitHub repository and set the remote url for your new project to it.
a. delete ``[email protected]:yoctoyotta1024/GoodSciProjTemplate.git`` from your remote with ``git remote remove origin``
b. add your repository: ``git remote add origin [[email protected]:your_repository_ssh.git]``
#. Delete any pre-existing tags and create the 0th version tag in the remote repository:
a. ``git tag`` to see any pre-existing tags, then ``git tag -d [pre-existing_tags]``
b. ``git tag -a v0.0.0 -m "init repo``
c. ``git push --tags``
d. ``git push -u origin main``
#. Switch to a new branch (not main!): ``git switch -c [branch_name]``, and start customising
the template... *(hint: each of the following changes is a seperate commit. Remember to use coventional
commit messages and don't push to your remote branch until the end.)*
#. Make yourself the ``github.repository_owner`` who triggers GitHub's CI to publish documentation
(see `.github/workflows/CI.yaml` and `.github/workflows/cocogitto.yaml`).
#. Switch to a new branch using git and start customising the template...

Necessary second steps:
#######################

#. Delete GoodSciProjTemplate's CHANGELOG.md ``rm CHANGELOG.md``.
#. Make the project name yours instead of "GoodSciProjTemplate".
#. Make the citation and liscence refer to you instead of me.
#. Corect the repository name and its owner for GitHub (e.g. in the CI.yaml).
#. Correct the repository name and its owner for GitHub (e.g. in the `.github/workflows/CI.yaml`).
#. Write a new README.md (shorter is generally better) and include a link to your documentation in it.
#. Change the GitHub links in the .rst files to the correct ones for your GitHub repository
(*hint*: you find these files in the `docs` directory).
#. Commit and push your changes to a branch of your GitHub repository (not main!).
#. Delete GoodSciProjTemplate's CHANGELOG.md ``rm CHANGELOG.md``.
#. Delete any pre-existing tags and push a 0th version tag to your remote repository:
a. ``git tag`` to see any pre-existing tags, then ``git tag -d [pre-existing_tags]``
b. ``git tag -a v0.0.0 -m "init repo``
c. ``git push --tags``
#. Setup (or delete) cocogitto (see :doc:`cocogitto`).
#. Build (or delete) C++ code in the repository (see :doc:`pybind11`).
#. Push all your changes to a branch of your GitHub repository (not main!).
a. ``git push --set-upstream origin [branch_name]``

Necessary second steps:
#######################

#. Create a pull request and accept it if your CI succeeds in order to to merge/rebase your
changes to the main branch of your remote (GitHub) repository.
#. Set your documentation to deploy using the `/(root)` folder of your gh-pages branch
#. Set your documentation to deploy using the `/(root)/` folder of your gh-pages branch
(see `instructions for gitHub publishing <https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site>`_).
#. Setup (or delete) cocogitto (see :doc:`cocogitto`).
#. Build (or delete) C++ code in the repository (see :doc:`pybind11`).


Some suggested third steps:
Expand Down

0 comments on commit ac8820d

Please sign in to comment.