Skip to content

Commit afb5f73

Browse files
authored
Update README.rst
1 parent 428733e commit afb5f73

File tree

1 file changed

+4
-50
lines changed

1 file changed

+4
-50
lines changed

Diff for: README.rst

+4-50
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,16 @@
1-
A Simple Python Project Skeleton
1+
FOSS Compliance Tools
22
================================
3-
This repo attempts to standardize the structure of the Python-based project's
4-
repositories using modern Python packaging and configuration techniques.
5-
Using this `blog post`_ as inspiration, this repository serves as the base for
6-
all new Python projects and is mergeable in existing repositories as well.
73

8-
.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
4+
This repo serves as a digital commons for content generated from the FOSS license and security compliance tools workshop before FOSDEM: https://workshop.aboutcode.org
95

106

117
Usage
128
=====
139

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``.
10+
-
3911

4012

4113
Release Notes
4214
=============
4315

44-
- 2023-07-18:
45-
- Add macOS-13 job in azure-pipelines.yml
46-
47-
- 2022-03-04:
48-
- Synchronize configure and configure.bat scripts for sanity
49-
- Update CI operating system support with latest Azure OS images
50-
- Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies
51-
There are now fewer scripts. See etc/scripts/README.rst for details
52-
53-
- 2021-09-03:
54-
- ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` and ``requirements-dev.txt``
55-
- ``configure`` can now accept multiple options at once
56-
- Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files
57-
- Rename virtual environment directory from ``tmp`` to ``venv``
58-
- Update README.rst with instructions for generating ``requirements.txt`` and ``requirements-dev.txt``,
59-
as well as collecting dependencies as wheels and generating ABOUT files for them.
60-
61-
- 2021-05-11:
62-
- Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used.
16+
-

0 commit comments

Comments
 (0)