Skip to content

Commit ca9d465

Browse files
committed
Polish readme, bump version to next SNAPSHOT
1 parent e662ac2 commit ca9d465

File tree

2 files changed

+18
-9
lines changed

2 files changed

+18
-9
lines changed

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
version=1.0.1-SNAPSHOT
1+
version=1.1.1-SNAPSHOT
22
org.gradle.jvmargs=-Xmx2G

readme.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ to help work with Ignition's custom data export formats.
77

88
### Thread Viewer
99

10-
Parses Ignition thread dump files, in JSON or plain text format.
10+
Parses Ignition thread dump files, in JSON or plain text format. Multiple thread dumps from the same system can be
11+
opened at once and will be automatically aggregated together.
1112

1213
### IDB Viewer
1314

14-
Opens Ignition .idb files and displays a list of tables and allows arbitrary SQL queries to be executed.
15+
Opens Ignition .idb files (SQLite DBs) and displays a list of tables and allows arbitrary SQL queries to be executed.
1516

1617
Has special handling for:
18+
1719
- Metrics files
1820
- System logs
1921

@@ -28,25 +30,32 @@ sequence them and present as a single view.
2830
Opens a zip file (including Ignition files like `.gwbk` or `.modl`). Allows opening other tools against the files within
2931
the zip, including the .idb files in a gateway backup.
3032

31-
## Store and Forward Cache Viewer
33+
### Store and Forward Cache Viewer
3234

3335
Opens the [HSQLDB](http://hsqldb.org/) file that contains the Store and Forward disk cache. Attempts to parse the
3436
Java-serialized data within into its object representation. If unable to deserialize (e.g. due to a missing class),
3537
falls back to a string explanation of the serialized data.
3638

37-
Note: If you encounter any issues with missing classes, please file an issue.
39+
Note: If you encounter any issues with missing classes, please file an issue.
3840

3941
## Usage
4042

41-
TODO
43+
1. Download the installer for your OS from the Downloads
44+
page: https://inductiveautomation.github.io/kindling/download.html
45+
2. Run the Kindling application.
46+
3. Open a supported file - either drag and drop directly onto the application window, click the `+` icon in the tab
47+
strip,
48+
or select a tool to open from the menubar.
49+
50+
Preferences are stored in `~/.kindling/preferences.json` and can be modified within the application from the menu bar.
4251

4352
## Development
4453

4554
Kindling uses Java Swing as a GUI framework, but is written almost exclusively in Kotlin, an alternate JVM language.
46-
Gradle is used as the build tool, and will automatically download the appropriate Gradle and Java version (via the
55+
Gradle is used as the build tool, and will automatically download the appropriate Gradle and JDK version (via the
4756
Gradle wrapper). Most IDEs (Eclipse, IntelliJ) should figure out the project structure automatically. You can directly
48-
run the main class in your IDE ([`MainPanel`](src/main/kotlin/io/github/inductiveautomation/kindling/MainPanel.kt)), or you
49-
can run the application via`./gradlew run` at the command line.
57+
run the main class in your IDE ([`MainPanel`](src/main/kotlin/io/github/inductiveautomation/kindling/MainPanel.kt)), or
58+
you can run the application via`./gradlew run` at the command line.
5059

5160
## Contribution
5261

0 commit comments

Comments
 (0)