launchpad-reviewers team mailing list archive

[Jürgen Gmach <mp+416158@xxxxxxxxxxxxxxxxxx>]

Jürgen Gmach has proposed merging ~jugmac00/git-build-recipe:add-readme into git-build-recipe:master.

Commit message:
Add basic readme

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~jugmac00/git-build-recipe/+git/git-build-recipe/+merge/416158
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~jugmac00/git-build-recipe:add-readme into git-build-recipe:master.

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..cb14b40
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,28 @@
+================
+git-build-recipe
+================
+
+Construct a git branch based on a "recipe".
+
+
+Running the test suite
+======================
+
+To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`_.
+
+.. note::
+
+    In order to run the test suite, you may need to install the following
+    packages:
+
+    .. code-block:: bash
+
+        sudo apt install devscripts, pristine-tar, quilt
+
+
+Getting help
+============
+
+If you find bugs in this package, you can report them here:
+
+    https://launchpad.net/git-build-recipe