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:
Tyler Wilding
2026-03-22 13:17:56 -04:00
committed by GitHub
parent 9fb8a1dc27
commit cbe21e3b4b
29 changed files with 593 additions and 417 deletions
+17 -10
View File
@@ -1,13 +1,20 @@
version: 3
vars:
GOALC_BIN_RELEASE_DIR: './build/goalc'
GK_BIN_RELEASE_DIR: './build/game'
DECOMP_BIN_RELEASE_DIR: './build/decompiler'
MEMDUMP_BIN_RELEASE_DIR: './build/tools'
TYPESEARCH_BIN_RELEASE_DIR: './build/tools'
OFFLINETEST_BIN_RELEASE_DIR: './build'
GOALCTEST_BIN_RELEASE_DIR: './build'
FORMATTER_BIN_RELEASE_DIR: './build/tools'
EXE_FILE_EXTENSION: ''
PYTHON: 'python3'
GOALC_BIN_RELEASE_DIR: "./build/goalc"
GK_BIN_RELEASE_DIR: "./build/game"
DECOMP_BIN_DEBUG_DIR: "./build/decompiler"
DECOMP_BIN_RELEASE_DIR: "./build/decompiler"
MEMDUMP_BIN_RELEASE_DIR: "./build/tools"
TYPESEARCH_BIN_RELEASE_DIR: "./build/tools"
OFFLINETEST_BIN_RELEASE_DIR: "./build"
GOALCTEST_BIN_RELEASE_DIR: "./build"
FORMATTER_BIN_RELEASE_DIR: "./build/tools"
EXE_FILE_EXTENSION: ""
PYTHON: "python3"
DEFAULT_CMAKE_RELEASE_PRESET: "Release-macos-arm64-clang"
DEFAULT_CMAKE_DEBUG_PRESET: ""
CMAKE_GEN_BUILD_DIR_RELEASE: "-B build"
CMAKE_GEN_BUILD_DIR_DEBUG: "-B build"
CMAKE_BUILD_DIR_RELEASE: "--build build"
CMAKE_BUILD_DIR_DEBUG: "--build build"
+17 -10
View File
@@ -1,13 +1,20 @@
version: 3
vars:
GOALC_BIN_RELEASE_DIR: './build/goalc'
GK_BIN_RELEASE_DIR: './build/game'
DECOMP_BIN_RELEASE_DIR: './build/decompiler'
MEMDUMP_BIN_RELEASE_DIR: './build/tools'
TYPESEARCH_BIN_RELEASE_DIR: './build/tools'
OFFLINETEST_BIN_RELEASE_DIR: './build'
GOALCTEST_BIN_RELEASE_DIR: './build'
FORMATTER_BIN_RELEASE_DIR: './build/tools'
EXE_FILE_EXTENSION: ''
PYTHON: 'python3'
GOALC_BIN_RELEASE_DIR: "./build/goalc"
GK_BIN_RELEASE_DIR: "./build/game"
DECOMP_BIN_DEBUG_DIR: "./build/decompiler"
DECOMP_BIN_RELEASE_DIR: "./build/decompiler"
MEMDUMP_BIN_RELEASE_DIR: "./build/tools"
TYPESEARCH_BIN_RELEASE_DIR: "./build/tools"
OFFLINETEST_BIN_RELEASE_DIR: "./build"
GOALCTEST_BIN_RELEASE_DIR: "./build"
FORMATTER_BIN_RELEASE_DIR: "./build/tools"
EXE_FILE_EXTENSION: ""
PYTHON: "python3"
DEFAULT_CMAKE_RELEASE_PRESET: "Release-linux-clang"
DEFAULT_CMAKE_DEBUG_PRESET: "Debug-linux-clang"
CMAKE_GEN_BUILD_DIR_RELEASE: "-B build"
CMAKE_GEN_BUILD_DIR_DEBUG: "-B build"
CMAKE_BUILD_DIR_RELEASE: "--build build"
CMAKE_BUILD_DIR_DEBUG: "--build build"
+18 -10
View File
@@ -1,13 +1,21 @@
version: 3
vars:
GOALC_BIN_RELEASE_DIR: './out/build/Release/bin'
GK_BIN_RELEASE_DIR: './out/build/Release/bin'
DECOMP_BIN_RELEASE_DIR: './out/build/Release/bin'
MEMDUMP_BIN_RELEASE_DIR: './out/build/Release/bin'
TYPESEARCH_BIN_RELEASE_DIR: './out/build/Release/bin'
OFFLINETEST_BIN_RELEASE_DIR: './out/build/Release/bin'
GOALCTEST_BIN_RELEASE_DIR: './out/build/Release/bin'
FORMATTER_BIN_RELEASE_DIR: './out/build/Release/bin'
EXE_FILE_EXTENSION: '.exe'
PYTHON: 'python'
GOALC_BIN_RELEASE_DIR: "./out/build/Release/bin"
GK_BIN_RELEASE_DIR: "./out/build/Release/bin"
DECOMP_BIN_DEBUG_DIR: "./out/build/Debug/bin"
DECOMP_BIN_RELEASE_DIR: "./out/build/Release/bin"
MEMDUMP_BIN_RELEASE_DIR: "./out/build/Release/bin"
TYPESEARCH_BIN_RELEASE_DIR: "./out/build/Release/bin"
OFFLINETEST_BIN_RELEASE_DIR: "./out/build/Release/bin"
GOALCTEST_BIN_RELEASE_DIR: "./out/build/Release/bin"
GOALCTEST_BIN_DEBUG_DIR: "./out/build/Debug/bin"
FORMATTER_BIN_RELEASE_DIR: "./out/build/Release/bin"
EXE_FILE_EXTENSION: ".exe"
PYTHON: "python"
DEFAULT_CMAKE_RELEASE_PRESET: "Release-windows-clang"
DEFAULT_CMAKE_DEBUG_PRESET: "Debug-windows-clang"
CMAKE_GEN_BUILD_DIR_RELEASE: ""
CMAKE_GEN_BUILD_DIR_DEBUG: ""
CMAKE_BUILD_DIR_RELEASE: "--build ./out/build/Release"
CMAKE_BUILD_DIR_DEBUG: "--build ./out/build/Debug"