Update README.md, move VS Code settings to doc

This commit is contained in:
Luke Street
2023-09-09 22:27:20 -04:00
parent 7e6bf468a8
commit bfcc2df0c0
6 changed files with 75 additions and 54 deletions
+2 -3
View File
@@ -1,9 +1,8 @@
__pycache__
.idea
.ninja_deps
.ninja_log
.vscode
.ninja_*
*.exe
!tools/sjiswrap.exe
build
build.ninja
objdiff.json
-25
View File
@@ -1,25 +0,0 @@
{
"configurations": [
{
"name": "Linux",
"includePath": [
"${workspaceFolder}/include/**"
],
"cStandard": "c99",
"cppStandard": "c++98",
"intelliSenseMode": "linux-clang-x86",
"compilerPath": "",
"configurationProvider": "ms-vscode.makefile-tools",
"browse": {
"path": [
"${workspaceFolder}/include"
],
"limitSymbolsToIncludedHeaders": true
},
"defines": [
"DEBUG"
]
}
],
"version": 4
}
-7
View File
@@ -1,7 +0,0 @@
{
"recommendations": [
"ms-vscode.cpptools",
"xaver.clang-format",
"ms-python.black-formatter"
]
}
-18
View File
@@ -1,18 +0,0 @@
{
"[c]": {
"files.encoding": "utf8",
"editor.defaultFormatter": "xaver.clang-format"
},
"[cpp]": {
"files.encoding": "utf8",
"editor.defaultFormatter": "xaver.clang-format"
},
"[python]":{
"editor.defaultFormatter": "ms-python.black-formatter"
},
"editor.tabSize": 2,
"files.autoSave": "onFocusChange",
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true,
"search.useIgnoreFiles": false,
}
+10 -1
View File
@@ -15,6 +15,10 @@ Dependencies
Windows:
--------
On Windows, it's **highly recommended** to use native tooling. WSL or msys2 are **not** required.
When running under WSL, [objdiff](#diffing) is unable to get filesystem notifications for automatic rebuilds.
- Install [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`.
- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`.
- Also available from the [Windows Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K).
@@ -43,7 +47,7 @@ Building
```
git clone https://github.com/encounter/ww.git
```
- Using [Dolphin Emulator](https://dolphin-emu.org/), extract your game to `orig/GZLE01`.
- Using [Dolphin Emulator](https://dolphin-emu.org/), extract your game to `orig/GZLE01` (or `GLZJ01` for JPN, `GLZE01` for PAL).
![](assets/dolphin-extract.png)
- To save space, the only necessary files are the following. Any others can be deleted.
- `sys/main.dol`
@@ -68,3 +72,8 @@ Download the latest release from [encounter/objdiff](https://github.com/encounte
Select an object from the left sidebar to begin diffing. Changes to the project will rebuild automatically: changes to source files, headers, `configure.py`, `splits.txt` or `symbols.txt`.
![](assets/objdiff.png)
More documentation
====================
- [Visual Studio Code](docs/vscode.md)
+63
View File
@@ -0,0 +1,63 @@
Visual Studio Code
==================
Settings
--------
Recommended `.vscode/settings.json`:
```jsonc
{
"[c]": {
"files.encoding": "utf8",
"editor.defaultFormatter": "xaver.clang-format"
},
"[cpp]": {
"files.encoding": "utf8",
"editor.defaultFormatter": "xaver.clang-format"
},
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter"
},
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true,
"search.useIgnoreFiles": false,
"search.exclude": {
"build/*/config.json": true,
"build/**/*.MAP": true,
"build.ninja": true,
".ninja_*": true,
"objdiff.json": true,
}
}
```
C/C++ configuration
-------------------
Recommended `.vscode/c_cpp_properties.json`:
```jsonc
{
"configurations": [
{
"name": "Linux",
"includePath": [
"${workspaceFolder}/include/**"
],
"cStandard": "c99",
"cppStandard": "c++98",
"intelliSenseMode": "linux-clang-x86",
"compilerPath": "",
"configurationProvider": "ms-vscode.makefile-tools",
"browse": {
"path": [
"${workspaceFolder}/include"
],
"limitSymbolsToIncludedHeaders": true
}
}
],
"version": 4
}
```