From 3e774dd9da2d01211d798daf6db63cc1a0edd71f Mon Sep 17 00:00:00 2001 From: markwkidd Date: Mon, 18 Feb 2019 14:06:11 -0500 Subject: [PATCH] organize development docs TOC / add git file format directives (#222) * organize developer TOC * add git file format metadata/directives --- .editorconfig | 21 +++++++++++++++++++++ .gitattributes | 16 ++++++++++++++++ mkdocs.yml | 20 ++++++++++---------- 3 files changed, 47 insertions(+), 10 deletions(-) create mode 100644 .editorconfig create mode 100644 .gitattributes diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..a2500729 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +# EditorConfig is awesome: http://EditorConfig.org + +# top-most EditorConfig file +root = true + +# Unix-style newlines with a newline ending every file +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 + +# Tab indentation (no size specified) +[Makefile] +indent_style = tab + +# Matches multiple files with brace expansion notation +# Set default charset +[*.{c,h}] +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..a958741b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,16 @@ +# Set the default behavior, in case people don't have core.autocrlf set. +* text=auto + +# Declare files that will always have LF Unix-style line endings on checkout. +*.c text eol=lf +*.h text eol=lf +*.in text eol=lf +*.md text eol=lf +*.txt text eol=lf + +# Denote all files that are truly binary and should not be modified. +*.png binary +*.jpg binary +*.gif binary +*.zip binary +*.pdf binary diff --git a/mkdocs.yml b/mkdocs.yml index 8cb07e92..80d44ca5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -214,6 +214,9 @@ pages: - Contributing: - 'How to Contribute to the Docs': 'guides/how-to-contribute.md' - For Developers: + - Libretro API and Ecosystem: + - 'Libretro API Overview': 'specs/api.md' + - 'Libretro Input API': 'specs/retropad.md' - Compilation: - Cores: - Nintendo Cores: @@ -255,18 +258,14 @@ pages: - 'PlayStation2': 'compilation/ps2.md' - 'PlayStation Portable': 'compilation/psp.md' - 'PlayStation Vita/TV': 'compilation/psvita.md' - - Meta: - - 'Core List': 'meta/core_list.md' - - 'To Do': 'meta/todo.md' - - 'Core Template': 'meta/core_template.md' - - 'See Also': 'meta/see_also.md' - RetroArch Development: - 'Debugging': 'tech/debugging.md' - 'Adding Menu Entries': 'tech/new-menu-options.md' + - 'Input Overlays': 'specs/overlay.md' - 'Licenses': 'tech/licenses.md' - 'MSVC Runtimes': 'tech/msvc-runtime-versions.md' - 'Adding Translations': 'tech/new-translations.md' - - Protocols: + - Network Protocols: - 'Netplay': 'tech/netplay.md' - 'Network Control Interface': 'tech/network-control-interface.md' - Core Development: @@ -276,10 +275,11 @@ pages: - Shader Development: - 'Shader Development Overview': 'specs/shader.md' - 'Content-Aware Shaders': 'tech/content-aware-shaders.md' - - Specifications: - - 'Libretro': 'specs/api.md' - - 'RetroPad': 'specs/retropad.md' - - 'Overlays': 'specs/overlay.md' + - Documentation Meta: + - 'Core List': 'meta/core_list.md' + - 'To Do': 'meta/todo.md' + - 'Core Template': 'meta/core_template.md' + - 'See Also': 'meta/see_also.md' extra: version: '0.1.0' font: