docs: update and try to make root-README a little less verbose

This commit is contained in:
Tyler Wilding
2026-03-20 20:11:09 -04:00
parent 96f944f971
commit a34135093b
11 changed files with 273 additions and 304 deletions
+18
View File
@@ -0,0 +1,18 @@
# Visual Studio
## Known Issues
- Later versions of 2022 have issues with intellisense when using clang
- Recent versions of 2026 have issues with CMake where the project will endlessly build:
- https://developercommunity.visualstudio.com/t/Switching-git-branches-seemingly-causes-/11025316?viewtype=all
## Steps
This will create a `jak-project` folder, open the project as a CMake project via Visual Studio.
![](/docs/img/windows/open-project.png)
Then build the entire project as `Windows Release (clang)`. You can also press Ctrl+Shift+B as a hotkey for Build All. We currently prefer `clang` on Windows as opposed to `msvc`, though it should work as well!
![](/docs/img/windows/release-build.png)
![](/docs/img/windows/build-all.png)
+11
View File
@@ -0,0 +1,11 @@
# VSCode
If you either don't want to or cannot use Visual Studio for working with the C++ project, VSCode is a good alternative.
The `clangd` extension is [recommended](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) and requires `clangd` to be on your `$PATH`. If you can run `clangd` in a terminal successfully then you should be good to go.
Once you generate your CMake for the first time the clangd LSP should be able to index the project and give you intellisense.
## Building and Debugging
TODO - Consider Contributing Documentation :)
+3
View File
@@ -0,0 +1,3 @@
# Zed
TODO