Skip to content

Commit 209da66

Browse files
authored
Add under the hood paragraph to README.md
1 parent 0f13664 commit 209da66

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ Explore, contribute, and customize the application according to your preferences
3333
- To run application execute `mvn javafx:run`.
3434
- To create ready to use app, archived into .zip, run `mvn package`. GitWave will be in `target/GitWave.zip` archive.
3535
- `GitWave.exe`, which run java image, is located in `tools` folder and generated by separate C++ project `tools/GitWaveExecutor`.
36+
37+
## :gear: Under the hood
38+
- GitWave is built on openjdk 11 + openjfx 11.
39+
- All commands and settings are stored in `config/config.json` in JSON format. So it is possible to edit them manually in any text editor.
40+
- On openning app makes lenient request to GitHub API to check for the new available release, see `com.github.introfog.gitwave.model.UpdateChecker#isNewReleaseAvailable`.
3641

3742
## :bulb: Ideas For Further Releases
3843
- Allow working with app by using only keyboard (with correct Tabs, Esc and so on work).

0 commit comments

Comments
 (0)