RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 15:57:35 +00:00
Code Issues Activity Actions

Documentation: Hide Meta/serenity.sh rebuild-toolchain

Browse source 
Unless a new toolchain update has been merged, users should not need to
rebuild their toolchain. Yet, the first thing they see in the build
documentation is to run `Meta/serenity.sh rebuild-toolchain`, which
might incorrectly lead them to use it whenever they encounter an error.
This is a waste of time and causes frustration.

Move any mentions of this option to `Troubleshooting.md` and add a note
to `BuildInstructions.md` about the toolchain build being a one-time
endeavor.
This commit is contained in:
Daniel Bertalan 2023-09-17 23:36:56 +02:00 • committed by Andrew Kaster
parent 9cd3477763
commit 715f452233
4 changed files with 36 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Documentation/NvimConfiguration.md
View file

@ -4,8 +4,7 @@ NVim can be configured to use the [COC-clangd](https://github.com/clangd/coc-cla
plugin to provide code-completion as well as inline
[git blame](https://github.com/f-person/git-blame.nvim) using [vim-plug](https://github.com/junegunn/vim-plug).
Make sure you ran `./Meta/serenity.sh rebuild-toolchain` as well as
`./Meta/serenity.sh run`.
Make sure you ran `Meta/serenity.sh run` at least once already.
# Install vim-plug