Added improvements section in README

This commit is contained in:
l_samenv
2024-08-21 16:09:04 +02:00
parent 2a75f9efb4
commit ca006cac17

View File

@ -16,20 +16,27 @@ This repository contains the code of the server for the control and graphical pa
variables_config.md <-- (ENG) User/programmer documentation about configuring parameters for the graphical part variables_config.md <-- (ENG) User/programmer documentation about configuring parameters for the graphical part
``` ```
## Installation (!!! WIP !!!) ## Procedures
### Installation (!!! WIP !!!)
1. Clone this repository on the `~` folder on your machine 1. Clone this repository on the `~` folder on your machine
2. If not done yet, activate a Python environnment 2. If not done yet, activate a Python environnment
3. Run the command `cd seaweb` 3. Run the command `cd seaweb`
## Configuring the application (!!! WIP !!!) ### Configuring the application (!!! WIP !!!)
## Starting the application (!!! WIP !!!) ### Starting the application (!!! WIP !!!)
1. Run the command `cd ~/seaweb` 1. Run the command `cd ~/seaweb`
## Stopping the application ### Stopping the application
1. Run the command `ps ax | grep seaweb` 1. Run the command `ps ax | grep seaweb`
2. In the output of the previous command, identifiy the PID corresponding to the server process 2. In the output of the previous command, identifiy the PID corresponding to the server process
3. Run the command `kill <previously_identified_PID>` 3. Run the command `kill <previously_identified_PID>`
## Possible improvements to bring
- When the livemode is activated on the server, the data of all available variables is sent, even if some of them are not displayed on the client
- The components made on the client use class instead of ids to identify the elements that are in their own context. To have a more lightweight code, and prevent side effects, it would be a good way to see if HTML shadow root could be used to isolate elements.