summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLuke Street <luke.street@encounterpc.com>2023-09-10 00:42:26 -0400
committerLuke Street <luke.street@encounterpc.com>2023-09-10 00:48:55 -0400
commitadb95b135c3d7498eba29bbd9728d345eed5a407 (patch)
tree655575b939c12067569263171b68c079b1a232c8 /docs
parent81ac53f1317dafb3506ae3ed8b2820d40645c3c8 (diff)
Import project
Original repository: https://github.com/encounter/ww
Diffstat (limited to 'docs')
-rw-r--r--docs/vscode.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/vscode.md b/docs/vscode.md
new file mode 100644
index 00000000..ef2f83f4
--- /dev/null
+++ b/docs/vscode.md
@@ -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
+}
+```