Merge branch 'main' of ssh://linarphy.net:56910/linarphy/naroo_reader into main

sync

README.md

@@ -1,3 +1,32 @@
 # naroo_reader
 
-convert NAROO image of spectrum to spectrum in fits format.
+Convert NAROO image of spectrum to spectrum in fits format.
+
+## Getting started
+
+Give the permission to execute the files `ETA.py` and `spectrum.py` with the command below.
+```shell
+chmod +x ETA.py spectrum.py
+```
+## Installation
+
+Download or clone this repo, then install needed python libraries with
+```shell
+python -m pip install -r requirements.txt
+```
+
+## Documentation
+
+Help is available by typing `./ETA.py -h` or `./spectrum.py -h`.
+
+## Authors
+
+* **linarphy** - *initial work*
+
+## Versioning
+
+We use [SemVer](http://semver.org) for versioning.
+
+## License
+
+This project is licensied under the Chocolate-Ware License - see the [LICENSE](LICENSE) file for more information.