Skip to content

Commit 7c8ea8f

Browse files
committed
updated towncrier and cheatsheet
1 parent 1d7f5d0 commit 7c8ea8f

File tree

2 files changed

+8
-46
lines changed

2 files changed

+8
-46
lines changed

CHEATSHEET.rst

Lines changed: 7 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,15 @@
1-
Finishing setting up your project
2-
=================================
3-
4-
Thanks for using cookiecutter-trio! This is your project now; you can
5-
customize it however you like. Here's some reminders of things you
6-
might want to do to get started:
7-
8-
* Check this into source control (``git init .; git add .; git
9-
commit -m "Initial commit"``)
10-
11-
* Add a CODE_OF_CONDUCT.md
12-
13-
* Add a CONTRIBUTING.md
14-
15-
* Search the source tree for COOKIECUTTER-TRIO-TODO to find other
16-
places to fill in.
17-
18-
* Enable `Read the Docs <https://readthedocs.org>`__. (Note: this
19-
project contains a ``.readthedocs.yml`` file that should be enough
20-
to get things working.)
21-
22-
* Set up continuous integration: Currently, this project is set up to
23-
test on Linux and MacOS using Travis, on Windows using Appveyor, and
24-
to test on PyPy.
25-
26-
If that's what you want, then go to Travis and Appveyor and enable
27-
testing for your repo.
28-
29-
If that's not what you want, then you can trim the list by modifying
30-
(or deleting) ``.travis.yml``, ``.appveyor.yml``, ``ci/travis.sh``.
31-
32-
* Enable `Codecov <https://codecov.io>`__ for your repo.
33-
34-
* File bugs or pull requests on `cookiecutter-trio
35-
<https://github.com/python-trio/cookiecutter-trio>`__ reporting any
36-
problems or awkwardness you ran into (no matter how small!)
37-
38-
* Delete this checklist once it's no longer useful
39-
40-
411
Tips
422
====
433

44-
To run tests
45-
------------
4+
How to test
5+
-----------
466

47-
* Install requirements: ``pip install -r ci/test-requirements.txt``
48-
(possibly in a virtualenv)
7+
There aren't any test cases yet. The reason is that most Linux distributions
8+
don't ship the ``gpio-mockup`` module that would allow me to control
9+
pseudo-GPIO pins from user space. Also, libgpiod isn't in Ubuntu stable yet.
4910

50-
* Actually run the tests: ``pytest trio_gpio``
11+
You can run the example programs on a Raspberry Pi, if you connect the right
12+
two pins on the expansion header.
5113

5214

5315
To run yapf

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ filename = "docs/source/history.rst"
44
directory = "newsfragments"
55
underlines = ["-", "~", "^"]
66
# COOKIECUTTER-TRIO-TODO: fill in the URL below to point to your issue tracker:
7-
issue_format = "`#{issue} <https://github.com/ACCOUNT/REPO/issues/{issue}>`__"
7+
issue_format = "`#{issue} <https://github.com/python-trio/trio-gpio/issues/{issue}>`__"

0 commit comments

Comments
 (0)