Skip to content

Commit ae73ce3

Browse files
authored
Merge pull request #61 from nexB/update-readme
Add usage instructions to README.rst
2 parents b408c85 + 6e43a7a commit ae73ce3

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.rst

+26-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,32 @@ our existing ones as well.
99

1010
Usage
1111
=====
12-
Usage instructions can be found in ``docs/skeleton-usage.rst``.
12+
13+
A brand new project
14+
-------------------
15+
.. code-block:: bash
16+
17+
git init my-new-repo
18+
cd my-new-repo
19+
git pull [email protected]:nexB/skeleton
20+
21+
# Create the new repo on GitHub, then update your remote
22+
git remote set-url origin [email protected]:nexB/your-new-repo.git
23+
24+
From here, you can make the appropriate changes to the files for your specific project.
25+
26+
Update an existing project
27+
---------------------------
28+
.. code-block:: bash
29+
30+
cd my-existing-project
31+
git remote add skeleton [email protected]:nexB/skeleton
32+
git fetch skeleton
33+
git merge skeleton/main --allow-unrelated-histories
34+
35+
This is also the workflow to use when updating the skeleton files in any given repository.
36+
37+
More usage instructions can be found in ``docs/skeleton-usage.rst``.
1338

1439
Release Notes
1540
=============

0 commit comments

Comments
 (0)