Skip to content

Commit 3e774dd

Browse files
markwkiddhizzlekizzle
authored andcommitted
organize development docs TOC / add git file format directives (#222)
* organize developer TOC * add git file format metadata/directives
1 parent 194f53d commit 3e774dd

File tree

3 files changed

+47
-10
lines changed

3 files changed

+47
-10
lines changed

.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Unix-style newlines with a newline ending every file
7+
[*]
8+
end_of_line = lf
9+
insert_final_newline = true
10+
charset = utf-8
11+
12+
# Tab indentation (no size specified)
13+
[Makefile]
14+
indent_style = tab
15+
16+
# Matches multiple files with brace expansion notation
17+
# Set default charset
18+
[*.{c,h}]
19+
indent_style = space
20+
indent_size = 2
21+
trim_trailing_whitespace = true

.gitattributes

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Set the default behavior, in case people don't have core.autocrlf set.
2+
* text=auto
3+
4+
# Declare files that will always have LF Unix-style line endings on checkout.
5+
*.c text eol=lf
6+
*.h text eol=lf
7+
*.in text eol=lf
8+
*.md text eol=lf
9+
*.txt text eol=lf
10+
11+
# Denote all files that are truly binary and should not be modified.
12+
*.png binary
13+
*.jpg binary
14+
*.gif binary
15+
*.zip binary
16+
*.pdf binary

mkdocs.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,9 @@ pages:
214214
- Contributing:
215215
- 'How to Contribute to the Docs': 'guides/how-to-contribute.md'
216216
- For Developers:
217+
- Libretro API and Ecosystem:
218+
- 'Libretro API Overview': 'specs/api.md'
219+
- 'Libretro Input API': 'specs/retropad.md'
217220
- Compilation:
218221
- Cores:
219222
- Nintendo Cores:
@@ -255,18 +258,14 @@ pages:
255258
- 'PlayStation2': 'compilation/ps2.md'
256259
- 'PlayStation Portable': 'compilation/psp.md'
257260
- 'PlayStation Vita/TV': 'compilation/psvita.md'
258-
- Meta:
259-
- 'Core List': 'meta/core_list.md'
260-
- 'To Do': 'meta/todo.md'
261-
- 'Core Template': 'meta/core_template.md'
262-
- 'See Also': 'meta/see_also.md'
263261
- RetroArch Development:
264262
- 'Debugging': 'tech/debugging.md'
265263
- 'Adding Menu Entries': 'tech/new-menu-options.md'
264+
- 'Input Overlays': 'specs/overlay.md'
266265
- 'Licenses': 'tech/licenses.md'
267266
- 'MSVC Runtimes': 'tech/msvc-runtime-versions.md'
268267
- 'Adding Translations': 'tech/new-translations.md'
269-
- Protocols:
268+
- Network Protocols:
270269
- 'Netplay': 'tech/netplay.md'
271270
- 'Network Control Interface': 'tech/network-control-interface.md'
272271
- Core Development:
@@ -276,10 +275,11 @@ pages:
276275
- Shader Development:
277276
- 'Shader Development Overview': 'specs/shader.md'
278277
- 'Content-Aware Shaders': 'tech/content-aware-shaders.md'
279-
- Specifications:
280-
- 'Libretro': 'specs/api.md'
281-
- 'RetroPad': 'specs/retropad.md'
282-
- 'Overlays': 'specs/overlay.md'
278+
- Documentation Meta:
279+
- 'Core List': 'meta/core_list.md'
280+
- 'To Do': 'meta/todo.md'
281+
- 'Core Template': 'meta/core_template.md'
282+
- 'See Also': 'meta/see_also.md'
283283
extra:
284284
version: '0.1.0'
285285
font:

0 commit comments

Comments
 (0)