Skip to content
Snippets Groups Projects
Commit bb17c00b authored by Lan Dam's avatar Lan Dam
Browse files

change README.md to README.rst, modify README.rst with new format, add HISTORY.rst

parent e2abebbe
No related branches found
No related tags found
1 merge request!2Gitlab CI pipeline and setup files
Pipeline #1219 failed with stage
in 17 seconds
=======
History
=======
2021.xxx
--------
* First release
### Description
SOHStationViewer is a tool to visualize State-of-Health packets from raw data recorded by different type of dataloggers.
### Directory Structure
````
sohstationviewer/
model/
lib/
view/
lib/
ui/
controller/
lib/
tests/
````
### Directory Description
#### sohstationviewer/
All codes for running sohstationviewer.
#### model/
Codes for reading data from raw files and reading setting data from config files.
**lib/** Core codes to be used for reading data.
#### view/
Codes for Graphical User Interface (GUI).
**lib/** Core GUI like plotting widget, common used GUI like log/message/error forms.
**ui/** ui files from QtDesigner.
#### controller/
Codes for logical processes.
**lib/** Core codes to be used for logical processes.
#### tests/
Unittest files for the codes. (GUI will not be included)
\ No newline at end of file
================
SOHStationViewer
================
Description
-----------
Visualize State-of-Health packets from raw data recorded by different type of dataloggers.
Directory Structure
-------------------
sohstationviewer/
model/
core/
view/
core/
ui/
controller/
core/
tests/
Directory Description
---------------------
**sohstationviewer/**
All codes for running sohstationviewer.
**sohstationviewer/model/**
Codes for reading data from raw files and setting data from config files.
**sohstationviewer/view/**
Codes for Graphical User Interface (GUI).
**sohstationviewer/view/ui/**
ui files from QtDesigner.
**sohstationviewer/controller/**
Codes for logical processes.
**tests/**
Unittest files for the codes. (GUI will not be tested)
License
-------
GNU General Public License v3 (GPLv3)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment