diff --git a/README.md b/README.md index e69de29..09483fe 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,15 @@ +# EpnTAPClient + +The goal of this application is to provide get VOTable data from services which support implements epn-core. + +## Dependencies + +You need java 7 to execute EpnTAPClient. + +## GUI usage + +Simply right-click on the jar and select *Open with* -> *Oracle Java 7 RunTime* (for example). + +## CLI usage + +No CLI usage are provided for now but this is planned. \ No newline at end of file diff --git a/src/main/java/eu/omp/irap/vespa/epntapclient/votable/README.md b/src/main/java/eu/omp/irap/vespa/epntapclient/votable/README.md new file mode 100644 index 0000000..653ced2 --- /dev/null +++ b/src/main/java/eu/omp/irap/vespa/epntapclient/votable/README.md @@ -0,0 +1,34 @@ +# VOTable + +## Context + +This library aims to provide a simple way to parse and view VOTables. The goal is to make the code +reusable and as light as possible. + +## Usage in command-line interface + +### 1. Reading a VOTable from an XML file + + VOtableApp pathToVOTable + +- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`. + +This will display the VOTable stored in the specified XML file, through a minimalist window. + +### 2. Reading a VOTable from an on-line service + + VOtableApp targetURL type language query + +This will display the VOTable resulting the service or registry request. + +- `targetURL`: The URL of the service or registry to ask, ie `http://cdpp-epntap.cesr.fr`; +- `language`: The language of the query, ie `ADQL`; +- `query`: The query in the specified language in double quotes, ie. `"SELECT * FROM amdadb.epn_core"` + +## Usage from a Java library + +Here is a start: + + VOTableController myVOTableController = new VOTableController(REGISTRY_URL, "ADQL", QUERY); + +See the Javadoc for more informations. \ No newline at end of file -- libgit2 0.21.2