Files
Tyler Wilding cbe21e3b4b docs: README pass, add alternative editor documentation (Zed) (#4137)
I'm switching away from visual studio (because its broken) so figured
I'd document / commit the minimum to get a working environment with the
editor I chose (Zed).

Also cleaned up the main README so it's not so verbose, link out to
secondary pages, etc.

I also deleted the Arch and Fedora dockerfiles, they were broken. The
ubuntu one still works, so i left it.
2026-03-22 13:17:56 -04:00

26 lines
950 B
Markdown

# Zed
Zed comes with out of the box C++ support via `clangd`. The project comes with a bunch of already setup task and debug configurations. Note that many of them depend on the usage of `task` to make them cross-OS compatible (Zed at this time doesn't allow for OS-conditional logic within the task definitions).
## Recommended Extensions:
- NeoCMake
## Building the Project
We are going to build a debug version of the project because that is most useful for development.
Run the `task: spawn` command (default shortcut is `Alt-Shift-T`) and run `Generate CMake: Debug`
![](/docs/img/editors/zed/zed-gen-cmake.png)
Then do the same thing to run `Build Project: Debug`
![](/docs/img/editors/zed/zed-build-proj.png)
The project is now fully built, you can now for example -- launch the REPL (`goalc`), or the game (`gk`) and attach breakpoints.
![](/docs/img/editors/zed/zed-run-example.png)
![](/docs/img/editors/zed/zed-debugger.png)