From c074c0a119f79d58c7e3fe98d3650a43be88aa2f Mon Sep 17 00:00:00 2001 From: Ed_ Date: Sun, 27 Aug 2023 16:56:49 -0400 Subject: [PATCH] Typo and elaboration of coventions section. --- docs/Readme.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Readme.md b/docs/Readme.md index 4424ced..2a5b3eb 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -2,12 +2,12 @@ ## 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. - -The order the engine is studied will be covered within in [jouney](journey.md). - +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 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. + ## 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.