mirror of
https://github.com/trailofbits/algo
synced 2024-11-13 19:12:06 +00:00
de12d51859
Reorganize documentation for clarity and use with GitHub pages static site generator. This closes #371.
14 lines
770 B
Markdown
14 lines
770 B
Markdown
### Filing New Issues
|
|
|
|
* Check that your issue is not already described in the [FAQ](docs/faq.md), [troubleshooting](docs/troubleshooting.md) docs, or an [existing issue](https://github.com/trailofbits/algo/issues)
|
|
* Did you remember to install the dependencies for your operating system prior to installing Algo?
|
|
* We only support modern operating systems, e.g. macOS 10.11+, iOS 9+, Windows 10+, Ubuntu 17.04+, etc.
|
|
* Cloud provider support is limited to DO, AWS, GCE, and Azure. Any others are best effort only.
|
|
* If you need to file a new issue, fill out any relevant fields in the Issue Template
|
|
|
|
### Pull Requests
|
|
|
|
* Run [ansible-lint](https://github.com/willthames/ansible-lint) or [shellcheck](https://github.com/koalaman/shellcheck) on any new scripts
|
|
|
|
Thanks!
|