File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -10,7 +10,32 @@ all new Python projects and is mergeable in existing repositories as well.
1010
1111Usage
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 git@github.com:nexB/skeleton
21+
22+ # Create the new repo on GitHub, then update your remote
23+ git remote set-url origin git@github.com: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 git@github.com: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
1641Release Notes
You can’t perform that action at this time.
0 commit comments