PYROS-IRAP / pyros

Commit b8064570e1e5754a7c7c8eb9653c5e16b317f298

Authored by Etienne Pallier
1 parent 5716be60
Exists in dev

better formatted README.md file

Showing 1 changed file with 56 additions and 37 deletions   Show diff stats
Inline Side-by-side
README.md
  Diff comments   View file @b806457
1   -PYROS (PYthon Robotic telescope Operating Software)
  1 +# PYROS (PYthon Robotic telescope Operating Software)
2 2 A Python software for the management of a Telescope control center
3 3  
4 4 COPYRIGHT (C) 2012-2018 IRAP (Institut de Recherche en Astrophysique et Planetologie) Toulouse - France
5 5  
6   -Authors : etienne.pallier@irap.omp.eu, paul.carensac@epitech.eu, alexandru.burlacu11@gmail.com, jeremy.barneron@gmail.com, quentin.durand@epitech.eu
  6 +Authors : etienne.pallier@irap.omp.eu, alain.klotz@irap.omp.eu, patrick.maeght@irap.omp.eu, paul.carensac@epitech.eu, alexandru.burlacu11@gmail.com, jeremy.barneron@gmail.com, quentin.durand@epitech.eu
7 7  
8 8 GPL License (http://www.gnu.org/copyleft/gpl.html) - See the file LICENSE.txt
9 9  
10   -This software runs with Python 3 and Django 2.0.5
  10 +This software runs with Python 3 and Django 2
11 11  
12   -To install it, go into the "install/" folder, and read the document INSTALLATION
  12 +To install it, go into the "install/" folder, and read the document INSTALLATION
  13 +(better is to go to https://docs.google.com/document/d/1m7wUGMUPNPE2gdsQNLILDeF738oIk9OlQjVjNzQyWA8/edit#heading=h.aqi3gs3yp2s3)
13 14  
14 15 -----------------------------------------------------------------------------------------------------------
  16 +## Tested platforms
  17 +
15 18 This software has been tested and validated with the following configurations :
16 19  
17 20 - Centos 7 (test server planetoweb2) :
... ... @@ -37,7 +40,7 @@ This software has been tested and validated with the following configurations :
37 40 - Apache 2.4.10
38 41  
39 42 --------------------------------------------------------------------------------------------
40   -PROJECT STRUCTURE:
  43 +## Project structure
41 44  
42 45 - src/ : conteneur du projet (le nom est sans importance)
43 46 - manage.py : utilitaire en ligne de commande permettant differentes actions sur le projet
... ... @@ -60,64 +63,80 @@ PROJECT STRUCTURE:
60 63 - static/
61 64  
62 65 --------------------------------------------------------------------------------------------
63   -LAST VERSION
  66 +## LAST VERSION
  67 +
  68 +Date: 10/10/18
64 69  
65   -Date: 9/10/18
66 70 By: E. Pallier
  71 +
67 72 VERSION: 2018.0.011.0
  73 +
68 74 - NEW versionning plan : YYYY.M.mmm.b
69   - - YYYY = Year
70   - - M = Major version number
71   - - mmm = Minor version number
72   - - b = Bugfix number
  75 + - YYYY = Year
  76 + - M = Major version number
  77 + - mmm = Minor version number
  78 + - b = Bugfix number
73 79 - new devices_channel/ folder containing the new DeviceControllerAbstract and ClientChannelAbstract classes (independant from pyros for the moment, but will soon be integrated)
74 80 - new src/utils/celme (celestial mecanics) library from Alain Klotz (more and more used inside pyros)
  81 +- better README.md formatted file
75 82  
  83 +--------------------------------------------------------------------------------------------
76 84 - TECHNICAL DOC: tinyurl/pyros-colibri
77 85 - DEV PLAN: https://docs.google.com/spreadsheets/d/1Gy6c-9fhUDBx5Bc6YrcGvfgP-HukWdhUh8oT11_y88g/edit#gid=664458270
78 86 - (OLD, TO BE UPDATED) https://projects.irap.omp.eu/versions/158
  87 +- ROADMAP (OLDish): https://projects.irap.omp.eu/projects/pyros/roadmap
79 88  
80   -ROADMAP: https://projects.irap.omp.eu/projects/pyros/roadmap
81 89 --------------------------------------------------------------------------------------------
82 90  
83   -IF EVER STRUCTURAL MODIFICATIONS NEED TO BE DONE MANUALLY AFTER UPDATE (git pull) :
84   -re-execute the installation script (python3 install.py update)
  91 +**IF EVER STRUCTURAL MODIFICATIONS NEED TO BE DONE MANUALLY AFTER UPDATE (git pull)** :
  92 +
  93 +=> re-execute the installation script (python3 install.py update)
85 94  
86 95 --------------------------------------------------------------------------------------------
87   -MAIN CHANGES (MILESTONES):
  96 +## MAIN CHANGES (MILESTONES):
88 97  
89 98 Full list of commits: https://gitlab.irap.omp.eu/epallier/pyros/commits/master
90 99  
91   -14/05/18 Version 0.18.001 (Q. Durand)
92   - Update all dependencies, update to django 2 and work in progress on the dashboard
  100 +**10/10/18 : Version 2018.0.011 (E. Pallier)**
  101 +- NEW versionning plan : YYYY.M.mmm.b
  102 + - YYYY = Year
  103 + - M = Major version number
  104 + - mmm = Minor version number
  105 + - b = Bugfix number
  106 +- new devices_channel/ folder containing the new DeviceControllerAbstract and ClientChannelAbstract classes (independant from pyros for the moment, but will soon be integrated)
  107 +- new src/utils/celme (celestial mecanics) library from Alain Klotz (more and more used inside pyros)
  108 +- better README.md formatted file
  109 +
  110 +**14/05/18 : Version 2018.0.001 (Q. Durand)**
  111 +- Update all dependencies, update to django 2 and work in progress on the dashboard
93 112  
94   -23/03/18 Version 0.16.11 (E. Pallier)
95   - All unit tests now pass WITHOUT celery (./manage.py test or ./pyros.py test)
  113 +**23/03/18 Version 0.16.11 (E. Pallier)**
  114 +- All unit tests now pass WITHOUT celery (./manage.py test or ./pyros.py test)
96 115  
97   -22/03/18 Version 0.16.10 (E. Pallier)
98   - New global variable USE_CELERY (false by default) in pyros.settings
  116 +**22/03/18 Version 0.16.10 (E. Pallier)**
  117 +- New global variable USE_CELERY (false by default) in pyros.settings
99 118  
100   -13/03/18 Version 0.16.7 (E. Pallier)
101   - Each agent (envmonitor, majordome, alert) can be started independently with a script (new script start_agent in each agent directory)
102   - New command "pyros start" to start pyros in different ways (different options : everything or only some components)
  119 +**13/03/18 Version 0.16.7 (E. Pallier)**
  120 +- Each agent (envmonitor, majordome, alert) can be started independently with a script (new script start_agent in each agent directory)
  121 +- New command "pyros start" to start pyros in different ways (different options : everything or only some components)
103 122  
104   -22/02/18 Version 0.16.5 (E. Pallier)
105   - Better isolation of Monitoring for easier testing (+ tuto)
  123 +**22/02/18 Version 0.16.5 (E. Pallier)**
  124 +- Better isolation of Monitoring for easier testing (+ tuto)
106 125  
107   -01/02/18 Version 0.16.3 (Q. Durand)
108   - New installation script src/install/install.py multiplatform (Lin-Mac-Win10, but also tested on Win7)
  126 +**01/02/18 Version 0.16.3 (Q. Durand)**
  127 +- New installation script src/install/install.py multiplatform (Lin-Mac-Win10, but also tested on Win7)
109 128  
110   -24/02/17 Version 0.15.1 - Added comments (Jeremy Barneron)
111   - Details added to describe the functions behavior
112   - https://projects.irap.omp.eu/versions/158
  129 +**24/02/17 Version 0.15.1 - Added comments (Jeremy Barneron)**
  130 +- Details added to describe the functions behavior
  131 +- https://projects.irap.omp.eu/versions/158
113 132  
114   -18/01/17 Version 0.15 - Execution with simulators
115   - Simulators evolution / majordome / monitoring / installer
116   - https://projects.irap.omp.eu/versions/158
  133 +**18/01/17 Version 0.15 - Execution with simulators**
  134 +- Simulators evolution / majordome / monitoring / installer
  135 +- https://projects.irap.omp.eu/versions/158
117 136  
118   -15/12/16 Version 0.14.1 - Final version 0.14
119   - Scenarist first versions
120   - https://projects.irap.omp.eu/versions/152
  137 +**15/12/16 Version 0.14.1 - Final version 0.14**
  138 +- Scenarist first versions
  139 +- https://projects.irap.omp.eu/versions/152
121 140  
122 141 02/08/16 Version 0.12.4 - Final version 0.12
123 142 Simulators first versions
... ...