REPLACE: One sentence description of the project.
REPLACE: Describe your project in more detail. What does it do? Who are the intended users? Why is it important or meaningful? How does it improve upon similar software? Is it a component of or extension to a larger piece of software?
REPLACE: How does on install the software? What are the dependencies, if any? Is there a Docker image or installation package of some sort?
REPLACE: How is the software run (or consumed, for libraries)? Are there any command line flags the user should know about? What do they do, exactly? What do the input data look like? Are there special file formats in use, what are they? What does the output look like?
REPLACE: What language(s) are in use? What does a user need to install for development purposes? This might include build systems, Docker, a particular compiler or runtime version, test libraries or tools, linters, code formatters, or other tools. Are there any special requirements, like processor architecture? What commands should developers use to accomplish common tasks like building, running the test suite, and so on?
We welcome external contributions, although it is a good idea to contact the maintainers before embarking on any significant development work to make sure the proposed changes are a good fit.
Contributors agree to license their code under the license in use by this
project (see LICENSE
).
To contribute:
- Fork the repo
- Make changes on a branch
- Create a pull request
See LICENSE
for details.
REPLACE: Who should people contact with questions?
See AUTHORS
the full list of authors.