File tree Expand file tree Collapse file tree 1 file changed +26
-1
lines changed Expand file tree Collapse file tree 1 file changed +26
-1
lines changed Original file line number Diff line number Diff line change @@ -9,7 +9,32 @@ our existing ones as well.
9
9
10
10
Usage
11
11
=====
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 git@github.com:nexB/skeleton
20
+
21
+ # Create the new repo on GitHub, then update your remote
22
+ git remote set-url origin git@github.com: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 git@github.com: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 ``.
13
38
14
39
Release Notes
15
40
=============
You can’t perform that action at this time.
0 commit comments