-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add usage instructions to README.rst
Signed-off-by: Jono Yang <[email protected]>
- Loading branch information
Showing
1 changed file
with
26 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
============= | ||
|