Skip to content

Commit 6238b83

Browse files
committed
Merge branch 'main' of https://github.com/nexB/skeleton into main
2 parents 931f610 + ae73ce3 commit 6238b83

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
@@ -10,7 +10,32 @@ all new Python projects and is mergeable in existing repositories as well.
1010

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

1540

1641
Release Notes

0 commit comments

Comments
 (0)