Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit 9a4a625

Browse files
committed
Merge remote-tracking branch 'github/skeleton'
2 parents 6cfcad6 + ee51693 commit 9a4a625

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

README.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ dls-python3-skeleton
33

44
|code_ci| |docs_ci| |coverage| |pypi_version| |license|
55

6-
This skeleton module is a generic Python project structure which provides a
7-
means to keep tools and techniques in sync between multiple Python projects.
6+
This skeleton module (inspired by `jaraco/skeleton
7+
<https://blog.jaraco.com/skeleton/>`_) is a generic Python project structure
8+
which provides a means to keep tools and techniques in sync between multiple
9+
Python projects.
810

911
============== ==============================================================
1012
PyPI ``pip install dls_python3_skeleton``
@@ -26,11 +28,13 @@ The ``skeleton`` branch of this module contains the source code that can be
2628
merged into new or existing projects, and pulled from to keep them up to date.
2729

2830
The ``master`` branch contains the
29-
docs and a command line tool to ease the adoption of this skeleton into new
31+
docs and a command line tool to ease the adoption of this skeleton into new::
32+
33+
dls-python3-skeleton new /path/to/be/created
34+
3035
and existing projects::
3136

32-
$ python -m dls_python3_skeleton new /path/to/be/created
33-
$ python -m dls_python3_skeleton existing /path/to/existing/repo
37+
dls-python3-skeleton existing /path/to/existing/repo
3438

3539
.. |code_ci| image:: https://github.com/dls-controls/dls-python3-skeleton/workflows/Code%20CI/badge.svg?branch=master
3640
:target: https://github.com/dls-controls/dls-python3-skeleton/actions?query=workflow%3A%22Code+CI%22

docs/tutorials/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Installation Tutorial
2-
=====================
1+
Installation
2+
============
33

44
.. note::
55

0 commit comments

Comments
 (0)