diff --git a/doc/README.md b/doc/README.md index 7632b2e..4ea914d 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,21 +1,24 @@ # Bemanitools 5 documentation + This folder contains various types of documentation. Table of contents: + * Key tools - * [Inject](inject.md): Readme for one of BT5's key applications, `inject.exe` - * [Launcher](launcher.md): Readme for another one of BT5's key applications, `launcher.exe` - * [Tools](tools/README.md): Documentation for additional user and development tooling + * [Inject](inject.md): Readme for one of BT5's key applications, `inject.exe` + * [Launcher](launcher.md): Readme for another one of BT5's key applications, `launcher.exe` + * [Tools](tools/README.md): Documentation for additional user and development tooling * Game hooks - * [ddrhook](ddrhook/README.md): Documentation relevant to `ddrhook` implementations - * [iidxhook](iidxhook/README.md): Documentation relevant to `iidxhook` implementations - * [jbhook](jbhook/README.md): Documentation relevant to `jbhook` implementations - * [sdvxhook](sdvxhook/README.md): Documentation relevant to `sdvxhook` implementations + * [ddrhook](ddrhook/README.md): Documentation relevant to `ddrhook` implementations + * [iidxhook](iidxhook/README.md): Documentation relevant to `iidxhook` implementations + * [jbhook](jbhook/README.md): Documentation relevant to `jbhook` implementations + * [sdvxhook](sdvxhook/README.md): Documentation relevant to `sdvxhook` implementations * Development - * [API](api.md): Available APIs for BT5 and instructions how to use them - * [Architecture](architecture.md): Outline of BT5's architecture, how things are designed and why - * [Development](development.md): Development environment, building, releasing, etc. - * [Developer documentation](dev/README.md): Various lose documentation/notes by developers - * [Tools](tools/README.md): Documentation for additional user and development tooling + * [API](api.md): Available APIs for BT5 and instructions how to use them + * [Architecture](architecture.md): Outline of BT5's architecture, how things are designed and why + * [Development](development.md): Development environment, building, releasing, etc. + * [Developer documentation](dev/README.md): Various lose documentation/notes by developers + * [Tools](tools/README.md): Documentation for additional user and development tooling * Hardware - * [Hardware](hardware/README.md): Anything related to hardware, e.g. IO boards \ No newline at end of file + * [Hardware](hardware/README.md): Anything related to hardware, e.g. IO boards +