aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
blob: f7568e16f39b61f012bee867b744918eaf702753 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Eden Build Documentation

Are you just a casual user? Take a look at our [User Handbook](./user) then!

If you want to register/signup as a contributor, take a gander at [CONTRIBUTING.md](../CONTRIBUTING.md).

This contains documentation created by developers, build instructions, guidelines, instructions/layouts for [cool stuff we made](./CPMUtil.md), and more.

- **[General Build Instructions](./Build.md)**
- **[CMake Options](./Options.md)**
- **[Cross Compiling](./CrossCompile.md)**
- **[Development Guidelines](./Development.md)**
- **[Dependencies](./Deps.md)**
- **[Debug Guidelines](./Debug.md)**
  - **[RenderDoc](./Debug.md#renderdoc)**
- **[CPM - CMake Package Manager](./CPMUtil.md)**
- **[Platform-Specific Caveats](./Caveats.md)**
- **[The NVIDIA SM86 (Maxwell) GPU](./NvidiaGpu.md)**
- **[Driver Bugs](./DriverBugs.md)**
- **[Building Older Commits](./build/OlderCommits.md)**
- Subsystems:
  - **[Design Overview](./DesignOverview.md)**
  - **[Dynarmic](./dynarmic/README.md)**
  - **[Subsystem: HLE](./SubsystemHLE.md)**
  - **[Settings](./Settings.md)**

## Policies

Policies and information on development.

- **[AI and LLM Usage](./policies/AI.md)**
- **[Coding guidelines](./policies/Coding.md)**
- **[Contributing](../CONTRIBUTING.md)**

## Externals

Other useful resources in general, take a quick read if you need.

- **[SwitchBrew](https://switchbrew.org/wiki/Main_Page)**
- **[IPS file format](https://zerosoft.zophar.net/ips.php)**
- **[IPSwitch file format](https://github.com/3096/ipswitch)**