diff --git a/README.md b/README.md index a73f404552bee35dc5854533c07b147ca8830afd..36fb28041d6516f5cb0b8fc54c15cdf00c2fa51b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ This is a viewer for JastAdd documentation generated by RagDoc Builder. +## Generating Documentation + +Generate the documentation by using the ragdoc task with JastAddGradle. + +The documentation metadata is output into build/docs/ragdoc. Copy the contents into +rd-view/src/data. + +## Customizing + +Change the title by editing the `title = ...;` line in `src/app/app.component.ts`. + +## Angular CLI + This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.0.1. ## Development server diff --git a/TODO b/TODO index 830b6d0085bce9c3fe138c43e1313ab065e11216..4692b7dd982273bcda75a0248fd21775615cbc50 100644 --- a/TODO +++ b/TODO @@ -4,6 +4,7 @@ ++ Add class overview as default page. ++ Make the title be a link to the default page. ++ Add modifier information to non-attribute members (public, static, etc.). +++ Don't display "extends Object" -- Add structured production representation. -- Add type hierarchy in type details. -- Add direct subtypes.