Skip to content

Commit 565feee

Browse files
committed
Add some minimal documentation
Signed-off-by: Steven Esser <sesser@nexb.com>
1 parent 9a56b88 commit 565feee

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.rst

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
A Simple Python Project Skeleton
22
================================
3-
Note: configure script requires src/ directory to run correctly.
3+
This repo attempts to standardize our python repositories using modern python
4+
packaging and configuration techniques. Using this `blog post`_ as inspiration, this
5+
repository will serve as the base for all new python projects and will be adopted to all
6+
our existing ones as well.
7+
8+
.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
9+
10+
Usage
11+
=====
12+
A brand new project
13+
-------------------
14+
.. code-block:: bash
15+
16+
git init my-new-repo
17+
cd my-new-repo
18+
git pull git@github.com:nexB/skeleton
19+
20+
From here, you can make the appropriate changes to the files for your specific project.
21+
22+
Update an existing project
23+
---------------------------
24+
.. code-block:: bash
25+
26+
cd my-existing-project
27+
git remote add skeleton git@github.com:nexB/skeleton
28+
git fetch skeleton
29+
git merge skeleton --allow-unrelated-histories
30+
31+
This is also the workflow to use when updating the skeleton files in any given repository.

0 commit comments

Comments
 (0)