From 84c08e2364044fe5f43a3cd441cdf8b1d78765d0 Mon Sep 17 00:00:00 2001 From: Robb Date: Mon, 12 Jun 2023 03:31:38 -0500 Subject: [PATCH] chore: additional developer setup info in the readme --- .vscode/extensions.json | 6 ++++++ README.md | 22 ++++++++++++++++++++-- cspell.json | 18 ++++++++++++++++++ 3 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 cspell.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..7f42c02 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "golang.go", + "streetsidesoftware.code-spell-checker" + ] +} \ No newline at end of file diff --git a/README.md b/README.md index c76cf47..50a006d 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,6 @@ Download the appropriate `.deb` for your CPU architecture. * [ARMv7 (32-bit ARM)](https://github.com/Vilsol/ficsit-cli/releases/latest/download/ficsit_linux_armv7.deb) * [PowerPC64](https://github.com/Vilsol/ficsit-cli/releases/latest/download/ficsit_linux_ppc64le.deb) - #### Fedora Download the appropriate `.rpm` for your CPU architecture. @@ -56,4 +55,23 @@ Download the appropriate `.apk` for your CPU architecture. ### macOS -Download the "all" build [here](https://github.com/Vilsol/ficsit-cli/releases/latest/download/ficsit_darwin_all). \ No newline at end of file +Download the "all" build [here](https://github.com/Vilsol/ficsit-cli/releases/latest/download/ficsit_darwin_all). + +## Troubleshooting + +* Config files are located in `%APPDATA%\ficsit\` + +## Development + +### Dependencies + +* [Go 1.18](https://go.dev/doc/install) +* IDE of Choice. Goland or VSCode suggested. + +## Building + +```bash +go build +``` + +Will produce `ficsit-cli.exe` in the repo root directory. diff --git a/cspell.json b/cspell.json new file mode 100644 index 0000000..3f859d1 --- /dev/null +++ b/cspell.json @@ -0,0 +1,18 @@ +// https://cspell.org/configuration/ +{ + // Version of the setting file. Always 0.2 + "version": "0.2", + // language - current active spelling language + "language": "en", + // words - list of words to be always considered correct + "words": [ + "ficsit", + "Goland" + ], + // flagWords - list of words to be always considered incorrect + // This is useful for offensive words and common spelling errors. + // cSpell:disable (don't complain about the words we listed here) + "flagWords": [ + "hte" + ] +}