From 621bd0f5aed617cd85566503ec833ab0cee01514 Mon Sep 17 00:00:00 2001
From: linarphy <linarphy@linarphy.net>
Date: Tue, 18 Jul 2023 13:54:33 +0000
Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 02f6095..c2c6c7f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
 # naroo_reader
 
-convert NAROO image of spectrum to spectrum in fits format.
\ No newline at end of file
+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.
\ No newline at end of file