Skip to content

Commit ff542a3

Browse files
committed
docs: updated README with minimalistic instructions
1 parent 26be1c4 commit ff542a3

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,26 @@
44
Context is a Java library for creating advanced user interfaces inside a console window
55

66
This is a very early proof of concept, nothing to see here (yet)
7+
8+
## Building
9+
10+
To build the project, run the following command:
11+
12+
```bash
13+
mvn clean package
14+
```
15+
16+
## Running
17+
18+
To see a simple demo of panels being drawn randomly on the screen, run the following command:
19+
20+
```bash
21+
java -cp target/context-1.0-SNAPSHOT.jar <example_class>
22+
```
23+
24+
Where `<example_class>` is one of the following:
25+
26+
- examples.Boxes
27+
- examples.FullPanel
28+
- examples.InlinePanel
29+
- examples.SimpleDom

0 commit comments

Comments
 (0)