Commit 69a585e2 authored by SAPONE Alann's avatar SAPONE Alann

updated readme

parent b4a26ce8
ETC-42
===========================
_______________
Introduction
------------
The ETC-42 is a generic exposure time calculator.
It has initialy been written at LAM (Laboratoire d'astrophysique de Marseille).
_______________
Dependencies
------------
- Maven
......@@ -13,14 +13,14 @@ Dependencies
- Latex full
- JRE 1.7+
- JDK 1.7+ (Open JDK isn't supported)
_______________
How to build
------------
To build, you need you use *Maven* as following in project root folder:
```
mvn package
```
_______________
Modules Description
-------------------
ETC-DataModel:
......@@ -50,7 +50,7 @@ ETC-WebStart:
ETC-Documentation:
- This module creates the latex documentation of the ETC.
_______________
Where to get generated outputs ?
-----------------------------
The files to use for distribution (output of the build) are:
......@@ -66,7 +66,7 @@ The files to use for distribution (output of the build) are:
- ETC-Documentation/target
In this directory are the pdf versions of the Latex documentation
```
_______________
Build the javadoc
-----------------
The ETC javadoc uses Latexlet to create scientific equations. For this reason
......@@ -78,7 +78,7 @@ mvn javadoc:javadoc
```
This will build the javadoc of each project separately and will put the files
in the directories <project>/target/site/apidocs
_______________
Common Problems and Solutions
-----------------------------
Here are listed some common problems during the ETC compilation and how to
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment