chore: additional developer setup info in the readme
This commit is contained in:
parent
daa6fba7e8
commit
84c08e2364
3 changed files with 44 additions and 2 deletions
6
.vscode/extensions.json
vendored
Normal file
6
.vscode/extensions.json
vendored
Normal file
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"recommendations": [
|
||||
"golang.go",
|
||||
"streetsidesoftware.code-spell-checker"
|
||||
]
|
||||
}
|
20
README.md
20
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.
|
||||
|
@ -57,3 +56,22 @@ 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).
|
||||
|
||||
## 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.
|
||||
|
|
18
cspell.json
Normal file
18
cspell.json
Normal file
|
@ -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"
|
||||
]
|
||||
}
|
Loading…
Reference in a new issue