Skip to content

Commit 5f93704

Browse files
committed
Update README.md.
1 parent 8b2f41a commit 5f93704

File tree

4 files changed

+40
-4
lines changed

4 files changed

+40
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Sierra is distributed via Maven Central at [org.httprpc:sierra](https://central.
1414

1515
A [DTD](sierra.dtd) is provided to assist with editing. It is not used for validation and is not required.
1616

17-
A custom DTD can be generated using the [DTD encoder](sierra-tools/dtd-encoder) tool. An interactive [preview tool](sierra-tools/previewer) is also available.
17+
A custom DTD can be generated using the [DTD encoder](sierra-tools/dtd-encoder) tool. An interactive [previewer](sierra-tools/previewer) tool is also available. Both can be downloaded [here](https://github.com/HTTP-RPC/Sierra/releases).
1818

1919
# Sierra Classes
2020
Sierra provides the `UILoader` class, which can be used in conjunction with the following types to to declaratively establish a hierarchy of user interface elements:

sierra-tools/dtd-encoder/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
# Sierra DTD Encoder
2-
TODO
2+
Generates a Sierra DTD file.
3+
4+
## Usage
5+
```
6+
dtd-encoder [bindings [classpath]]
7+
```
8+
9+
The first argument represents the path to a properties file containing the custom bindings. Keys represent markup tags, and values are the fully qualified class names to which the tags will be bound. For example:
10+
11+
```properties
12+
chart-panel = org.jfree.chart.ChartPanel
13+
```
14+
15+
The second argument is the path to a directory containing the dependencies (typically the JAR files containing the types to be bound).
16+
17+
Both arguments are relative to the current directory.
18+
19+
If no arguments are provided, the standard Sierra DTD will be generated.
20+
21+
## Example
22+
```
23+
$ dtd-encoder bindings.properties build/libs
24+
```

sierra-tools/previewer/README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
1-
# Sierra Previewer
2-
TODO
1+
# Sierra UI Previewer
2+
Provides a live, interactive preview of Sierra markup.
3+
4+
## Usage
5+
```
6+
previewer
7+
```
8+
9+
Outlets and resource keys are ignored.
10+
11+
## Example
12+
```
13+
$ previewer
14+
```
15+
16+
<img src="README/previewer.png" width="904px"/>
629 KB
Loading

0 commit comments

Comments
 (0)