diff --git a/docs/Analyzer API.md b/docs/Analyzer_API.md similarity index 100% rename from docs/Analyzer API.md rename to docs/Analyzer_API.md diff --git a/readme.md b/readme.md index 39fb41f..51fca36 100644 --- a/readme.md +++ b/readme.md @@ -42,7 +42,7 @@ After that, the script will complete the renaming process and exit. Once renamed, you're ready to build your analyzer! See the [Building your Analyzer](#Building-your-Analyzer) section below. -API documentation can be found in `./docs/Analyzer API.md`. +API documentation can be found in [docs/Analyzer_API.md](docs/Analyzer_API.md). ## Cloud Building & Publishing @@ -50,6 +50,8 @@ This example repository includes support for GitHub actions, which is a continuo When building in CI, the release version of the analyzer is built for Windows, Linux, and MacOS. The built analyzer files are available for every CI build. Additionally, GitHub releases are automatically created for any tagged commits, making it easy to share pre-built binaries with others once your analyzer is complete. +Learn how to tag a commit here: https://stackoverflow.com/questions/18216991/create-a-tag-in-a-github-repository + ### Using downloaded analyzer binaries on MacOS This section only applies to downloaded pre-built protocol analyzer binaries on MacOS. If you build the protocol analyzer locally, or acquire it in a different way, this section does not apply.