1
0
mirror of https://github.com/craigerl/aprsd.git synced 2024-11-17 22:01:49 -05:00
Commit Graph

11 Commits

Author SHA1 Message Date
f534646288 Updated README with more workflow details 2021-01-11 08:26:30 -05:00
cc0d0fd523 Added APRSD system diagram to docs
This patch adds the aprsd overview diagram to the
main README as well as the generated docs.
2021-01-10 16:11:53 -05:00
7423df6b25 Added some more badges to readme files
Added badges for both docs/readme.rst and main README.rst
2021-01-09 20:12:23 -05:00
ee2aeb5157 Added Sphinx based documentation
This patch adds the docuemntation source tree in docs.

You can build the documentation with

tox -edocs

View the documentation by opening a browser and viewing
aprsd/docs/_build/index.html
2021-01-09 14:12:13 -05:00
25d948b0ee Updated README to include development env
This patch shows how to setup a development environment.

Please use the steps as laid out and install the pre-commit
hooks to ensure the code is clean prior to commit.
2021-01-06 20:03:25 -05:00
75f610d971 Added pre-commit hooks
This patch adds pre-commit hook support to ensure
code passes basic checks prior to allowing a commit.
2021-01-06 17:54:50 -05:00
8161719697 Update README with version 1.1.0 related info
This patch adds more detailed information about the aprsd app, and
plugins.
2020-12-20 21:19:43 -05:00
6a61765eba Updated README.rst
This patch updates the README.rst with sample help and output from
various commands
2020-12-20 12:36:47 -05:00
21253ff6e7 Updated README with a TOC
This patch updates the README.rst to include an index table at the top
as well as a section describing building and using the docker container
2020-12-15 10:51:02 -05:00
3ffa4165f0 Updated README with development information 2020-12-14 16:06:07 -05:00
e1edbe6c62 Rewrote the README.md to README.rst
This patch rewrote the README.md file to an README.rst
so that pypi might be able to consume it.
2020-12-14 11:35:10 -05:00