From 7432ea06e1f8066c3bb26a603f8075e078377947 Mon Sep 17 00:00:00 2001 From: Christian Semmler Date: Sun, 3 Dec 2023 16:30:32 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99f25975..c053d643 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,14 @@ This repository currently has only one goal: accuracy to the original executable ## Overview -* `3rdparty`: Contains code obtained from third parties, not including Mindscape. Generally, these are libraries that have been placed in the public domain or are freely available on the web. As these are unaltered files, our style guide (see below) does not apply. -* `ISLE`: Decompilation of `ISLE.EXE`. It depends on some code in `LEGO1`. -* `LEGO1`: Decompilation of `LEGO1.DLL`. This folder contains code from Mindscape's custom in-house engine called **Omni** (file pattern: `mx*`), the LEGO Island-specific extensions for Omni and the game's code (file pattern: `lego*`) as well as several utility libraries (`realtime`, `tgl`, `viewmanager`) developed by Mindscape. +* [3rdparty](/3rdparty): Contains code obtained from third parties, not including Mindscape. Generally, these are libraries that have been placed in the public domain or are freely available on the web. As these are unaltered files, our style guide (see below) does not apply. +* [ISLE](/ISLE): Decompilation of `ISLE.EXE`. It depends on some code in `LEGO1`. +* [LEGO1](/LEGO1): Decompilation of `LEGO1.DLL`. This folder contains code from Mindscape's custom in-house engine called **Omni** (file pattern: `mx*`), the LEGO Island-specific extensions for Omni and the game's code (file pattern: `lego*`) as well as several utility libraries developed by Mindscape. +* [tools](/tools): A set of tools aiding in the decompilation effort. + +## Tooling + +Please make yourself familiar with the available tooling and annotations [here](/tools/README.md). ## Code Style