Typo and elaboration of coventions section.

This commit is contained in:
Edward R. Gonzalez 2023-08-27 16:56:49 -04:00
parent 9cfb761b04
commit c074c0a119

View File

@ -2,12 +2,12 @@
## Conventions ## Conventions
These docs will be written in a free-flow fasion. The main purpose of this repo is to remove the knowledge barrier to the engine. There are plenty of content written for this engine, but its not provided in a way that is easy to digest. These docs will be written in a free-flow fasion. The main purpose of this repo is to remove the knowledge barrier to the engine. There are plenty of content written for this engine, but its not provided in a way that is easy to digest.
The order the engine is studied will be covered within in [journey](journey.md).
The order the engine is studied will be covered within in [jouney](journey.md). The perspective of the reader is for someone who's become accostomed to using the engine and is vaugely familiar with the code base, however they never really looked through the engine because there is no actual docs.
Hopefully if the reader is interested in learning the engine, this approach will at least give an idea of how they could approach going about it. Hopefully if the reader is interested in learning the engine, this approach will at least give an idea of how they could approach going about it.
## Project ## Project
There is one project used for the entire study. It will essentially utilize any features from the engine covered, however it will not use any custom fork of the engine. The purpose is to learn the engine as is, and not to modify it. There is one project used for the entire study. It will essentially utilize any features from the engine covered, however it will not use any custom fork of the engine. The purpose is to learn the engine as is, and not to modify it.