diff --git a/.github/readme-files/DEVELOPER_GUIDE.md b/.github/readme-files/DEVELOPER_GUIDE.md index 1bea10c..23cc39f 100644 --- a/.github/readme-files/DEVELOPER_GUIDE.md +++ b/.github/readme-files/DEVELOPER_GUIDE.md @@ -2,11 +2,11 @@ ## Table of Contents * [Introduction](#introduction) -* [Design](#design) -* [Implementation](#implementation) -* [Code Documentation](#code-documentation) +* [Project structure](#project-structure) +* [Assets & Languages](#Assets-&-Languages) +* [Database](#code-documentation) +* [Services & UI](#services-&-ui) * [Testing](#testing) -* [Final Notes](#final-notes)
@@ -41,6 +41,9 @@ At a high level overview, the entire project can be broken down into **4 compone Each of components corresponds to one or two folders in project structure. Below a short\ description of folders and files. +---------------------- +Note: This tree not use syntax described above + .\ ├── assets |                *RESOURSES*\ │   └── lang |                *TRANSLATION FILES*\ @@ -95,4 +98,20 @@ description of folders and files. ├── pyproject.toml |                *ALMOST UNUSED*\ ├── README.md |                *GITHUB README\ ├── requirements.txt |                *CREATES WITH pipreqs*\ -└── WORKFLOW.md |                *THIS FILE* \ No newline at end of file +└── WORKFLOW.md |                *THIS FILE* + +------------------ + +## Assets & Languages +*soon* + +## Database +*soon* + +## Commands & Interactions +*soon* + +## Services & UI +*soon* + +## Testing