From bb829d88b9e07d8c71bbba07c6880162eb6239f0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jesper=20=C3=96qvist?= <jesper.oqvist@cs.lth.se>
Date: Mon, 12 Feb 2018 17:02:40 +0100
Subject: [PATCH] Update README
---
.travis.yml | 4 ++++
README.md | 22 +++++++++-------------
2 files changed, 13 insertions(+), 13 deletions(-)
create mode 100644 .travis.yml
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..45e9d6b
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,4 @@
+language: java
+
+jdk:
+ - oraclejdk8
diff --git a/README.md b/README.md
index 01bc600..35ad8cd 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,10 @@
# RagDoc Builder
-This is a tool for building documentation metadata about JastAdd applications.
+This is a tool for building documentation metadata for JastAdd projects.
+RD-Builder outputs JSON files with documentation metadata. The documentation
+can be viewed with RagDoc Viewer.
-Run RD-Builder on the generated Java code of your JastAdd project as if
-compiling the code. RD-Builder outputs a bunch of JSON files describing the
-structure of the input classes. The generated documentation can be viewed with
-RagDoc Viewer.
-
-RagDoll depends on the following projects:
-
-* `extendj`
-* `se.llbit:jo-json`
-
## Building
Build the tool with Gradle:
@@ -23,8 +15,8 @@ Build the tool with Gradle:
## Usage
-Run RagDoc Builder just like a regular Java compiler. The output is written to
-the path specified by the `-d` option:
+Run RagDoc Builder on the generated JastAdd code, just like a regular Java compiler.
+The output is written to the path specified by the `-d` option:
java -jar rd-builder.jar -d docs -classpath $CLASSPATH File1.java ...
@@ -32,3 +24,7 @@ the path specified by the `-d` option:
The documentation is generated as a set of `.json` files containing information about
the classes and attributes in the input sources. This information can be viewed on
a webpage using RagDoc Viewer.
+
+RagDoc Builder can also be run using JastAddGradle. By running RagDoc Builder
+this way, you won't have to set up the full compile path because JastAddGradle
+knows how to compile the generated JastAdd code.
--
GitLab