mirror of
https://github.com/open-goal/jak-project
synced 2026-08-22 07:04:29 -04:00
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.
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
# 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`
|
||||
|
||||

|
||||
|
||||
Then do the same thing to run `Build Project: Debug`
|
||||
|
||||

|
||||
|
||||
The project is now fully built, you can now for example -- launch the REPL (`goalc`), or the game (`gk`) and attach breakpoints.
|
||||
|
||||

|
||||
|
||||

|
||||
Reference in New Issue
Block a user