Skip to content

Commit

Permalink
upd: Format
Browse files Browse the repository at this point in the history
  • Loading branch information
baidakovil authored Dec 11, 2023
1 parent 517cfa8 commit d8265a6
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions .github/readme-files/DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<div style="page-break-after: always;"></div>

Expand Down Expand Up @@ -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*\
Expand Down Expand Up @@ -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*
└── WORKFLOW.md |                *THIS FILE*

------------------

## Assets & Languages
*soon*

## Database
*soon*

## Commands & Interactions
*soon*

## Services & UI
*soon*

## Testing

0 comments on commit d8265a6

Please sign in to comment.