linse/seweb
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation tree in README

Browse Source
This commit is contained in:
l_samenv
2024-08-21 15:20:55 +02:00
parent 8534187ab8
commit 44ead1cd5e
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -4,9 +4,17 @@ The WEB GUI client of SEA.
This repository contains the code of the server for the control and graphical parts, plus the client code (HTML, CSS, JS) This repository contains the code of the server for the control and graphical parts, plus the client code (HTML, CSS, JS)
## Global architecture ## Documentation
The current server exposes some routes for the graphical part and the control part. It also serves the client files. ```
./doc/
blocks.tsv <-- (DE) Indicates the position of the different blocks depending on the screen size
client.md <-- (ENG) Developper documentation about the client part
message_chain.txt <-- (ENG) Gives the message chain (API calls) for builiding the different blocks
protocol.txt <-- (ENG) Gives a summary of the different server response payloads
server.md <-- (ENG) Developper documentation about the server part
variables_config.md <-- (ENG) User/programmer documentation about configuring parameters for the graphical part
```
## Installation (!!! WIP !!!) ## Installation (!!! WIP !!!)