From 44ead1cd5ee6e7f5de45609ffb45e8c9f2757132 Mon Sep 17 00:00:00 2001 From: l_samenv Date: Wed, 21 Aug 2024 15:20:55 +0200 Subject: [PATCH] Documentation tree in README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 797bb82..46df438 100644 --- a/README.md +++ b/README.md @@ -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) -## 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 !!!)