Merge pull request #69 from Hedonium/contribute

Update CONTRIBUTING.md, how-to-contribute.md, see_also.md
This commit is contained in:
Twinaphex 2018-04-03 03:18:02 +02:00 committed by GitHub
commit ab2be6217e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 129 additions and 83 deletions

View File

@ -18,3 +18,16 @@ make sure that you are comparing **your forks edited branch** to the **docs mast
There is a To-Do list for libretro/docs [here](https://docs.libretro.com/meta/todo/)
You can submit suggestions or issues regarding documentation at the [libretro/docs issue tracker](https://github.com/libretro/docs/issues) or in our [forum thread](https://forums.libretro.com/t/wip-adding-pages-to-documentation-site/10078/).
## Adding a new core
These are the documents that should be added/updated when a new core is added to the libretro ecosystem.
- Add the core to docs/library/
- Add the core to mkdocs.yml
- Add the core to docs/meta/core_list.md
- Add the core to docs/meta/see_also.md if it supports RetroArch databases or if it's related to another core in some way
- Add the core to docs/tech/licenses.md
- Add the core to docs/meta/todo.md
- Add the core to docs/guides/softpatching.md if it supports softpatching
- Add the core to docs/guides/retroachievements.md if it supports cheevos

View File

@ -18,3 +18,16 @@ make sure that you are comparing **your forks edited branch** to the **docs mast
There is a To-Do list for libretro/docs [here](https://docs.libretro.com/meta/todo/)
You can submit suggestions or issues regarding documentation at the [libretro/docs issue tracker](https://github.com/libretro/docs/issues) or in our [forum thread](https://forums.libretro.com/t/wip-adding-pages-to-documentation-site/10078/).
## Adding a new core
These are the documents that should be added/updated when a new core is added to the libretro ecosystem.
- Add the core to docs/library/
- Add the core to mkdocs.yml
- Add the core to docs/meta/core_list.md
- Add the core to docs/meta/see_also.md if it supports RetroArch databases or if it's related to another core in some way
- Add the core to docs/tech/licenses.md
- Add the core to docs/meta/todo.md
- Add the core to docs/guides/softpatching.md if it supports softpatching
- Add the core to docs/guides/retroachievements.md if it supports cheevos

View File

@ -1,153 +1,153 @@
// This is a list of cores that share databases with each other.
// This is a list of cores that support RetroArch databases
#### Amstrad - CPC
## Amstrad - CPC
- [Amstrad - CPC (Caprice32)](https://docs.libretro.com/library/caprice32/)
- [Amstrad - CPC (CrocoDS)](https://docs.libretro.com/library/crocods/)
#### Atari - 2600
## Atari - 2600
- [Atari - 2600 (Stella)](https://docs.libretro.com/library/stella/)
#### Atari - 5200
## Atari - 5200
- [Atari - 5200 (Atari800)](https://docs.libretro.com/library/atari800/)
#### Atari - 7800
## Atari - 7800
- [Atari - 7800 (ProSystem)](https://docs.libretro.com/library/prosystem/)
#### Atari - Jaguar
## Atari - Jaguar
- [Atari - Jaguar (Virtual Jaguar)](https://docs.libretro.com/library/virtual_jaguar/)
#### Atari - Lynx
## Atari - Lynx
- [Atari - Lynx (Beetle Handy)](https://docs.libretro.com/library/beetle_handy/)
- [Atari - Lynx (Handy)](https://docs.libretro.com/library/handy/)
#### Atari - ST
## Atari - ST
- [Atari - ST/STE/TT/Falcon (Hatari)](https://docs.libretro.com/library/hatari/)
#### Bandai - WonderSwan
## Bandai - WonderSwan
- [Bandai - WonderSwan/Color (Beetle Cygne)](https://docs.libretro.com/library/beetle_cygne/)
#### Bandai - WonderSwan Color
## Bandai - WonderSwan Color
- [Bandai - WonderSwan/Color (Beetle Cygne)](https://docs.libretro.com/library/beetle_cygne/)
#### Cave Story
## Cave Story
- [Cave Story (NXEngine)](https://docs.libretro.com/library/nxengine/)
#### ChaiLove
## ChaiLove
- [ChaiLove](https://docs.libretro.com/library/chailove/)
#### Coleco - ColecoVision
## Coleco - ColecoVision
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](https://docs.libretro.com/library/bluemsx/)
#### Commodore - 64
## Commodore - 64
- [Commodore - C64 (VICE C64)](https://docs.libretro.com/library/vice_c64/)
#### DOOM
## DOOM
- [Doom (PrBoom)](https://docs.libretro.com/library/prboom/)
#### DOS
## DOS
- [DOS (DOSBox)](https://docs.libretro.com/library/dosbox/)
#### Dinothawr
## Dinothawr
- [Dinothawr](https://docs.libretro.com/library/dinothawr/)
#### FB Alpha - Arcade Games
## FB Alpha - Arcade Games
- [Arcade (FB Alpha)](https://docs.libretro.com/library/fb_alpha/)
#### GCE - Vectrex
## GCE - Vectrex
- [GCE - Vectrex (vecx)](https://docs.libretro.com/library/vecx/)
#### Handheld Electronic Game
## Handheld Electronic Game
- [Handheld Electronic (GW)](https://docs.libretro.com/library/gw/)
#### Lutro
## Lutro
- [Lua Engine (Lutro)](https://docs.libretro.com/library/lutro/)
#### MAME
## MAME
- [Arcade (MAME)](https://docs.libretro.com/library/mame/)
#### MAME 2000
## MAME 2000
- [Arcade (MAME 2000)](https://docs.libretro.com/library/mame_2000/)
#### MAME 2003
## MAME 2003
- [Arcade (MAME 2003)](https://docs.libretro.com/library/mame_2003/)
- [Arcade (MAME 2003 Midway)](https://docs.libretro.com/library/mame_2003_midway/)
#### MAME 2010
## MAME 2010
- [Arcade (MAME 2010)](https://docs.libretro.com/library/mame_2010/)
#### MAME 2014
## MAME 2014
- [Arcade (MAME 2014)](https://docs.libretro.com/library/mame_2014/)
#### Magnavox - Odyssey2
## Magnavox - Odyssey2
- [Magnavox - Odyssey2 / Phillips Videopac+ (O2EM)](https://docs.libretro.com/library/o2em/)
#### Mattel - Intellivision
## Mattel - Intellivision
- [Mattel - Intellivision (FreeIntv)](https://docs.libretro.com/library/freeintv/)
#### Microsoft - MSX
## Microsoft - MSX
- [Microsoft - MSX (fMSX)](https://docs.libretro.com/library/fmsx/)
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](https://docs.libretro.com/library/bluemsx/)
#### Microsoft - MSX2
## Microsoft - MSX2
- [Microsoft - MSX (fMSX)](https://docs.libretro.com/library/fmsx/)
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](https://docs.libretro.com/library/bluemsx/)
#### MrBoom
## MrBoom
- [Mr.Boom (Bomberman)](https://docs.libretro.com/library/mr_boom/)
#### NEC - PC Engine - TurboGrafx 16
## NEC - PC Engine - TurboGrafx 16
- [NEC - PC Engine / CD (Beetle PCE FAST)](https://docs.libretro.com/library/beetle_pce_fast/)
#### NEC - PC Engine CD - TurboGrafx-CD
## NEC - PC Engine CD - TurboGrafx-CD
- [NEC - PC Engine / CD (Beetle PCE FAST)](https://docs.libretro.com/library/beetle_pce_fast/)
#### NEC - PC Engine SuperGrafx
## NEC - PC Engine SuperGrafx
- [NEC - PC Engine SuperGrafx (Beetle SGX)](https://docs.libretro.com/library/beetle_sgx/)
#### NEC - PC-FX
## NEC - PC-FX
- [NEC - PC-FX (Beetle PC-FX)](https://docs.libretro.com/library/beetle_pc_fx/)
#### Nintendo - Family Computer Disk System
## Nintendo - Family Computer Disk System
- [Nintendo - NES / Famicom (FCEUmm)](https://docs.libretro.com/library/fceumm/)
- [Nintendo - NES / Famicom (Mesen)](https://docs.libretro.com/library/mesen/)
- [Nintendo - NES / Famicom (Nestopia UE)](https://docs.libretro.com/library/nestopia_ue/)
#### Nintendo - Game Boy
## Nintendo - Game Boy
- [Nintendo - Game Boy / Color (Emux GB)](https://docs.libretro.com/library/emux_gb/)
- [Nintendo - Game Boy / Color (Gambatte)](https://docs.libretro.com/library/gambatte/)
@ -158,7 +158,7 @@
- [Nintendo - SNES / Famicom (higan Accuracy)](https://docs.libretro.com/library/higan_accuracy/)
- [Nintendo - SNES / Famicom (nSide Balanced)](https://docs.libretro.com/library/nside_balanced/)
#### Nintendo - Game Boy Advance
## Nintendo - Game Boy Advance
- [Nintendo - Game Boy Advance (Beetle GBA)](https://docs.libretro.com/library/beetle_gba/)
- [Nintendo - Game Boy Advance (gpSP)](https://docs.libretro.com/library/gpsp/)
@ -168,7 +168,7 @@
- [Nintendo - Game Boy Advance (VBA-M)](https://docs.libretro.com/library/vba_m/)
- [Nintendo - Game Boy Advance (VBA Next)](https://docs.libretro.com/library/vba_next/)
#### Nintendo - Game Boy Color
## Nintendo - Game Boy Color
- [Nintendo - Game Boy / Color (Emux GB)](https://docs.libretro.com/library/emux_gb/)
- [Nintendo - Game Boy / Color (Gambatte)](https://docs.libretro.com/library/gambatte/)
@ -179,46 +179,46 @@
- [Nintendo - SNES / Famicom (higan Accuracy)](https://docs.libretro.com/library/higan_accuracy/)
- [Nintendo - SNES / Famicom (nSide Balanced)](https://docs.libretro.com/library/nside_balanced/)
#### Nintendo - GameCube
## Nintendo - GameCube
- [Nintendo - GameCube / Wii (Dolphin)](https://docs.libretro.com/library/dolphin/)
#### Nintendo - Nintendo 3DS
## Nintendo - Nintendo 3DS
- [Nintendo - 3DS (Citra)](https://docs.libretro.com/library/citra/)
- [Nintendo - 3DS (Citra Canary/Experimental)](https://docs.libretro.com/library/citra_canary/)
#### Nintendo - Nintendo 64
## Nintendo - Nintendo 64
- [Nintendo - Nintendo 64 (Mupen64Plus)](https://docs.libretro.com/library/mupen64plus/)
- [Nintendo - Nintendo 64 (Mupen64Plus GLES3)](https://docs.libretro.com/library/mupen64plus_gles3/)
- [Nintendo - Nintendo 64 (ParaLLEl N64)](https://docs.libretro.com/library/parallel_n64/)
#### Nintendo - Nintendo 64DD
## Nintendo - Nintendo 64DD
- [Nintendo - Nintendo 64 (Mupen64Plus)](https://docs.libretro.com/library/mupen64plus/)
- [Nintendo - Nintendo 64 (Mupen64Plus GLES3)](https://docs.libretro.com/library/mupen64plus_gles3/)
- [Nintendo - Nintendo 64 (ParaLLEl N64)](https://docs.libretro.com/library/parallel_n64/)
#### Nintendo - Nintendo DS (Download Play)
## Nintendo - Nintendo DS (Download Play)
- [Nintendo - DS (DeSmuME 2015)](https://docs.libretro.com/library/desmume_2015/)
- [Nintendo - DS (DeSmuME)](https://docs.libretro.com/library/desmume/)
- [Nintendo - DS (melonDS)](https://docs.libretro.com/library/melonds)
#### Nintendo - Nintendo DS Decrypted
## Nintendo - Nintendo DS Decrypted
- [Nintendo - DS (DeSmuME 2015)](https://docs.libretro.com/library/desmume_2015/)
- [Nintendo - DS (DeSmuME)](https://docs.libretro.com/library/desmume/)
- [Nintendo - DS (melonDS)](https://docs.libretro.com/library/melonds)
#### Nintendo - Nintendo DS
## Nintendo - Nintendo DS
- [Nintendo - DS (DeSmuME 2015)](https://docs.libretro.com/library/desmume_2015/)
- [Nintendo - DS (DeSmuME)](https://docs.libretro.com/library/desmume/)
- [Nintendo - DS (melonDS)](https://docs.libretro.com/library/melonds)
#### Nintendo - Nintendo Entertainment System
## Nintendo - Nintendo Entertainment System
- [Nintendo - NES / Famicom (bnes)](https://docs.libretro.com/library/bnes/)
- [Nintendo - NES / Famicom (Emux NES)](https://docs.libretro.com/library/emux_nes/)
@ -227,15 +227,15 @@
- [Nintendo - NES / Famicom (Nestopia UE)](https://docs.libretro.com/library/nestopia_ue/)
- [Nintendo - NES / Famicom (QuickNES)](https://docs.libretro.com/library/quicknes/)
#### Nintendo - Pokemon Mini
## Nintendo - Pokemon Mini
- [Nintendo - Pokémon Mini (PokeMini)](https://docs.libretro.com/library/pokemini/)
#### Nintendo - Satellaview
## Nintendo - Satellaview
- [Nintendo - SNES / Famicom (Snes9x)](https://docs.libretro.com/library/snes9x/)
#### Nintendo - Sufami Turbo
## Nintendo - Sufami Turbo
- [Nintendo - SNES / Famicom (Beetle bsnes)](https://docs.libretro.com/library/beetle_bsnes/)
- [Nintendo - SNES / Famicom (bsnes-mercury Accuracy)](https://docs.libretro.com/library/bsnes_mercury_accuracy/)
@ -251,7 +251,7 @@
- [Nintendo - SNES / Famicom (Snes9x 2005)](https://docs.libretro.com/library/snes9x_2005/)
- [Nintendo - SNES / Famicom (Snes9x 2010)](https://docs.libretro.com/library/snes9x_2010/)
#### Nintendo - Super Nintendo Entertainment System
## Nintendo - Super Nintendo Entertainment System
- [Nintendo - SNES / Famicom (Beetle bsnes)](https://docs.libretro.com/library/beetle_bsnes/)
- [Nintendo - SNES / Famicom (bsnes-mercury Accuracy)](https://docs.libretro.com/library/bsnes_mercury_accuracy/)
@ -269,7 +269,7 @@
- [Nintendo - SNES / Famicom (Snes9x 2005)](https://docs.libretro.com/library/snes9x_2005/)
- [Nintendo - SNES / Famicom (Snes9x 2010)](https://docs.libretro.com/library/snes9x_2010/)
#### Nintendo - Super Nintendo Entertainment System Hacks
## Nintendo - Super Nintendo Entertainment System Hacks
- [Nintendo - SNES / Famicom (Beetle bsnes)](https://docs.libretro.com/library/beetle_bsnes/)
- [Nintendo - SNES / Famicom (bsnes-mercury Accuracy)](https://docs.libretro.com/library/bsnes_mercury_accuracy/)
@ -287,132 +287,132 @@
- [Nintendo - SNES / Famicom (Snes9x 2005)](https://docs.libretro.com/library/snes9x_2005/)
- [Nintendo - SNES / Famicom (Snes9x 2010)](https://docs.libretro.com/library/snes9x_2010/)
#### Nintendo - Virtual Boy
## Nintendo - Virtual Boy
- [Nintendo - Virtual Boy (Beetle VB)](https://docs.libretro.com/library/beetle_vb/)
#### Nintendo - Wii
## Nintendo - Wii
- [Nintendo - GameCube / Wii (Dolphin)](https://docs.libretro.com/library/dolphin/)
#### Quake1
## Quake1
- [Quake 1 (TyrQuake)](https://docs.libretro.com/library/tyrquake/)
#### RPG Maker
## RPG Maker
- [RPG Maker 2000/2003 (EasyRPG)](https://docs.libretro.com/library/easyrpg/)
#### Rick Dangerous
## Rick Dangerous
- [Rick Dangerous (XRick)](https://docs.libretro.com/library/xrick/)
#### SNK - Neo Geo Pocket
## SNK - Neo Geo Pocket
- [SNK - Neo Geo Pocket / Color (Beetle NeoPop)](https://docs.libretro.com/library/beetle_neopop/)
#### SNK - Neo Geo Pocket Color
## SNK - Neo Geo Pocket Color
- [SNK - Neo Geo Pocket / Color (Beetle NeoPop)](https://docs.libretro.com/library/beetle_neopop/)
#### ScummVM
## ScummVM
- [ScummVM](https://docs.libretro.com/library/scummvm/)
#### Sega - 32X
## Sega - 32X
- [Sega - MS/MD/CD/32X (PicoDrive)](https://docs.libretro.com/library/picodrive/)
#### Sega - Dreamcast
## Sega - Dreamcast
- [Sega - Dreamcast (Redream)](https://docs.libretro.com/library/redream/)
- [Sega - Dreamcast (Reicast)](https://docs.libretro.com/library/reicast/)
#### Sega - Game Gear
## Sega - Game Gear
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](https://docs.libretro.com/library/genesis_plus_gx/)
- [Sega - MS/GG (Gearsystem)](https://docs.libretro.com/library/gearsystem/)
#### Sega - Master System - Mark III
## Sega - Master System - Mark III
- [Sega - Master System (Emux SMS)](https://docs.libretro.com/library/emux_sms/)
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](https://docs.libretro.com/library/genesis_plus_gx/)
- [Sega - MS/MD/CD/32X (PicoDrive)](https://docs.libretro.com/library/picodrive/)
- [Sega - MS/GG (Gearsystem)](https://docs.libretro.com/library/gearsystem/)
#### Sega - Mega Drive - Genesis
## Sega - Mega Drive - Genesis
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](https://docs.libretro.com/library/genesis_plus_gx/)
- [Sega - MS/MD/CD/32X (PicoDrive)](https://docs.libretro.com/library/picodrive/)
#### Sega - Mega-CD - Sega CD
## Sega - Mega-CD - Sega CD
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](https://docs.libretro.com/library/genesis_plus_gx/)
- [Sega - MS/MD/CD/32X (PicoDrive)](https://docs.libretro.com/library/picodrive/)
#### Sega - PICO
## Sega - PICO
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](https://docs.libretro.com/library/genesis_plus_gx/)
- [Sega - MS/MD/CD/32X (PicoDrive)](https://docs.libretro.com/library/picodrive/)
#### Sega - Saturn
## Sega - Saturn
- [Sega - Saturn (Beetle Saturn)](https://docs.libretro.com/library/beetle_saturn/)
- [Sega - Saturn (Yabause)](https://docs.libretro.com/library/yabause/)
#### Sega - SG-1000
## Sega - SG-1000
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](https://docs.libretro.com/library/bluemsx/)
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](https://docs.libretro.com/library/genesis_plus_gx/)
#### Sharp - X68000
## Sharp - X68000
- [Sharp - X68000 (PX68k)](https://docs.libretro.com/library/px68k/)
#### Sinclair - ZX 81
## Sinclair - ZX 81
- [Sinclair - ZX 81 (EightyOne)](https://docs.libretro.com/library/eightyone/)
#### Sinclair - ZX Spectrum +3
## Sinclair - ZX Spectrum +3
- [ZX Spectrum (Fuse)](https://docs.libretro.com/library/fuse/)
#### Sinclair - ZX Spectrum
## Sinclair - ZX Spectrum
- [ZX Spectrum (Fuse)](https://docs.libretro.com/library/fuse/)
#### Sony - PlayStation Portable
## Sony - PlayStation Portable
- [Sony - PlayStation Portable (PPSSPP)](https://docs.libretro.com/library/ppsspp/)
#### Sony - PlayStation
## Sony - PlayStation
- [Sony - PlayStation (Beetle PSX HW)](https://docs.libretro.com/library/beetle_psx_hw/)
- [Sony - PlayStation (Beetle PSX)](https://docs.libretro.com/library/beetle_psx/)
- [Sony - PlayStation (PCSX ReARMed)](https://docs.libretro.com/library/pcsx_rearmed/)
#### The 3DO Company - 3DO
## The 3DO Company - 3DO
- [The 3DO Company - 3DO (4DO)](https://docs.libretro.com/library/4do/)
#### Tomb Raider
## Tomb Raider
- [Tomb Raider (OpenLara)](https://docs.libretro.com/library/openlara/)
#### Uzebox
## Uzebox
- [Uzebox (Uzem)](https://docs.libretro.com/library/uzem/)
---
// Non-Database relations
// This is a list of cores that are related to each other in a way that doesn't involve sharing RetroArch databases
#### Custom Engine
## Custom Engine
- [ChaiLove](https://docs.libretro.com/library/chailove/)
- [Lua Engine (Lutro)](https://docs.libretro.com/library/lutro/)
#### Media
## Media
- [FFmpeg](https://docs.libretro.com/library/ffmpeg/)
- [Game Music Emu](https://docs.libretro.com/library/game_music_emu/)
@ -420,7 +420,27 @@
- [mpv](https://docs.libretro.com/library/mpv/)
- [PocketCDG](https://docs.libretro.com/library/pocketcdg/)
#### id Software
## id Software
- [Doom (PrBoom)](https://docs.libretro.com/library/prboom/)
- [Quake 1 (TyrQuake)](https://docs.libretro.com/library/tyrquake/)
## Arcade
- [MAME](https://docs.libretro.com/library/mame/)
- [MAME 2000](https://docs.libretro.com/library/mame_2000/)
- [MAME 2003](https://docs.libretro.com/library/mame_2003/)
- [MAME 2003 Midway](https://docs.libretro.com/library/mame_2003_midway/)
- [MAME 2003-Plus - Experimental](https://docs.libretro.com/library/mame_2003_plus/)
- [MAME 2009](https://docs.libretro.com/library/mame_2009/)
- [MAME 2010](https://docs.libretro.com/library/mame_2010/)
- [MAME 2014](https://docs.libretro.com/library/mame_2014/)
- [MAME 2016](https://docs.libretro.com/library/mame_2016/)
- [MESS 2014](https://docs.libretro.com/library/mess_2014/)
- [UME 2014](https://docs.libretro.com/library/ume_2014/)
- [FB Alpha](https://docs.libretro.com/library/fb_alpha/)
- [FB Alpha 2012](https://docs.libretro.com/library/fb_alpha_2012/)
- [FB Alpha 2012 CPS-1](https://docs.libretro.com/library/fb_alpha_cps1/)
- [FB Alpha 2012 CPS-2](https://docs.libretro.com/library/fb_alpha_cps2/)
- [FB Alpha 2012 CPS-3](https://docs.libretro.com/library/fb_alpha_cps3/)
- [FB Alpha 2012 Neo Geo](https://docs.libretro.com/library/fb_alpha_neogeo/)