Update contributing.md to reflect recent subprojects

This commit is contained in:
James Groom 2023-10-29 06:25:09 +10:00 committed by GitHub
parent deae681225
commit db589ee856
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 9 deletions

View File

@ -4,15 +4,18 @@ Jump to:
- [For any: .NET project](#for-any-net-project)
- Projects
- [blip_buf](#blip_buf)
- [Citra](#citra)
- [Cygne](#cygne)
- [DiscoHawk](#discohawk)
- [EmuHawk](#emuhawk)
- [Ext. tools](#ext-tools)
- [FlatBuffers (managed)](#flatbuffers-managed)
- [Handy](#handy)
- [HawkQuantizer](#hawkquantizer)
- [iso-parser](#iso-parser)
- [LibBizAbiAdapter](#libbizabiadapter)
- [LibBizHash](#libbizhash)
- [libmupen64plus](#libmupen64plus)
- [librcheevos](#librcheevos)
- [LibretroBridge](#libretrobridge)
- [Mednadisc](#mednadisc)
- [Misc. submodules](#misc-submodules)
@ -86,6 +89,13 @@ Uses C.
## Citra
> Build scripts for the (unmanaged side of the) Citra port.
Uses C++.
## Cygne
> The unmanaged side of the Cygne core from Mednafen.
@ -141,13 +151,6 @@ These use C#; you will need the .NET SDK or an IDE which includes it. See the [.
## FlatBuffers (managed)
> Library (incl. generated code) used for serialisation in Nyma cores.
Uses C#; you will need the .NET SDK or an IDE which includes it. See the [.NET section](#for-any-net-project).
## Handy
> The unmanaged side of the Handy core from Mednafen.
@ -169,6 +172,20 @@ Uses C#; you will need the .NET SDK or an IDE which includes it. See the [.NET s
## LibBizAbiAdapter
> A tiny shim used by `BizHawk.BizInvoke`.
Uses x86 assembly.
## LibBizHash
> Used for hardware-accelerated computation of checksums, since proper ISA extension support isn't available until .NET 6.
Uses C.
## libmupen64plus
> The unmanaged side of the Mupen64Plus core and its bundled plugins.
@ -176,6 +193,13 @@ These use C/C++.
## librcheevos
> Build scripts for the rcheevos library, used for RetroAchievements support in EmuHawk.
Uses C.
## LibretroBridge
> The unmanaged side of EmuHawk's Libretro adapter.
@ -255,9 +279,15 @@ These use C#; you will need the .NET SDK or an IDE which includes it. See the [.
### BizHawk Analyzer
> Performs additional code style checks not covered by the other Analyzers.
### ReflectionCache source generator
### ReflectionCache Source Generator
> Generates a helper class in an assembly for accessing `<EmbeddedResource/>`s and `Type`s.
### SettingsUtil Source Generator
> Extra codegen for settings and sync settings object serialisation.
### VersionInfo Source Generator
> Adds metadata from Git to `BizHawk.Common`.
## Virtu