Merge ~jugmac00/git-build-recipe:add-readme into git-build-recipe:master

Proposed by Jürgen Gmach
Status: Merged
Merged at revision: 3850943fe6316d20f0c5bf5182660fd78444dc6c
Proposed branch: ~jugmac00/git-build-recipe:add-readme
Merge into: git-build-recipe:master
Diff against target: 34 lines (+28/-0)
1 file modified
README.rst (+28/-0)
Reviewer Review Type Date Requested Status
Colin Watson (community) Approve
Review via email: mp+416158@code.launchpad.net

Commit message

Add basic readme

To post a comment you must log in.
Revision history for this message
Colin Watson (cjwatson) :
review: Approve
Revision history for this message
Colin Watson (cjwatson) :

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.rst b/README.rst
2new file mode 100644
3index 0000000..14e0643
4--- /dev/null
5+++ b/README.rst
6@@ -0,0 +1,28 @@
7+================
8+git-build-recipe
9+================
10+
11+Construct a git branch based on a "recipe".
12+
13+
14+Running the test suite
15+======================
16+
17+To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`_.
18+
19+.. note::
20+
21+ In order to run the test suite, you may need to install the following
22+ packages:
23+
24+ .. code-block:: bash
25+
26+ sudo apt install devscripts pristine-tar quilt
27+
28+
29+Getting help
30+============
31+
32+If you find bugs in this package, you can report them here:
33+
34+ https://launchpad.net/git-build-recipe

Subscribers

People subscribed via source and target branches