From 11f7a1c341e355dfbd95824a5074c497b51ad114 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jesper=20=C3=96qvist?= <jesper.oqvist@cs.lth.se> Date: Thu, 22 Mar 2018 13:47:11 +0100 Subject: [PATCH] Update README --- README.md | 13 +++++++++++++ TODO | 1 + 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index a73f404..36fb280 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 830b6d0..4692b7d 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. -- GitLab