UE5_Study/docs
2023-11-28 22:08:58 -05:00
..
Build & Automation System Did 80/20 for Automation Tool docs. 2023-11-28 22:08:58 -05:00
Launch Started to document the build tool. 2023-08-27 16:45:54 -04:00
journey.md Did 80/20 for Automation Tool docs. 2023-11-28 22:08:58 -05:00
Readme.md Small progress on ubt doc 2023-08-31 15:45:22 -04:00

Documentation Outline

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 Journey.

The perspective of the writting is from 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.

The project and docs will be referencing and building the engine from scratch using the release branch from the git repostiory.