Start from somewhere

README.md

@@ -0,0 +1,79 @@
+Pasteque core
+=============
+
+Common libraries for Pasteque.
+
+Setup
+-----
+
+This projects can use either Maven or Ant and Ivy.
+
+### Setting up Maven
+
+This build uses `pom.xml`.
+
+Install maven with (Debian-based)
+
+```
+apt install maven
+```
+
+The initialization is done automatically when building the project.
+
+### Setting up Ant and Ivy
+
+This build uses `build.xml` and `ivy.xml`.
+
+Install And and Ivy (Debian-based)
+
+```
+apt install ant ivy
+```
+
+Debian doesn't link Ivy to Ant by default.
+
+```
+ln -s /usr/share/java/ivy.jar /usr/share/ant/lib/ivy.jar
+```
+
+Install the required dependencies with Ivy.
+
+```
+ant resolve
+```
+
+This will download the dependencies from Maven repositories and put them in `ant-lib`.
+
+Build commands
+--------------
+
+### Compile
+
+```
+mvn compile
+or
+ant compile
+```
+
+It will create compiled classes in `target/classes`
+
+### Generate the documentation
+
+```
+mvn javadoc:javadoc
+or
+ant javadoc
+```
+
+This will generate the javadoc and put it it `target/site/apidocs`.
+
+### Clean the project
+
+```
+mvn clean
+or
+ant clean
+ant lib-clean
+```
+
+It will delete the `target` directory. Te reset ant dependencies, use `ant lib-clean` to remove `ant-lib`.