Skip to content

Commit

Permalink
Add usage instructions to README.rst
Browse files Browse the repository at this point in the history
Signed-off-by: Jono Yang <[email protected]>
  • Loading branch information
JonoYang committed Mar 9, 2022
1 parent b408c85 commit 6e43a7a
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,32 @@ our existing ones as well.

Usage
=====
Usage instructions can be found in ``docs/skeleton-usage.rst``.

A brand new project
-------------------
.. code-block:: bash
git init my-new-repo
cd my-new-repo
git pull [email protected]:nexB/skeleton
# Create the new repo on GitHub, then update your remote
git remote set-url origin [email protected]:nexB/your-new-repo.git
From here, you can make the appropriate changes to the files for your specific project.

Update an existing project
---------------------------
.. code-block:: bash
cd my-existing-project
git remote add skeleton [email protected]:nexB/skeleton
git fetch skeleton
git merge skeleton/main --allow-unrelated-histories
This is also the workflow to use when updating the skeleton files in any given repository.

More usage instructions can be found in ``docs/skeleton-usage.rst``.

Release Notes
=============
Expand Down

0 comments on commit 6e43a7a

Please sign in to comment.