Mercurial Hosting > junotu

changeset 35:8cc09761cf18

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added 'Compiling / Packaging' section to the README file
author Fox
date Thu, 18 Aug 2022 20:12:22 +0200
parents 06b4a235d4bc
children 11bf54badc99
files README.md
diffstat 1 files changed, 12 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Thu Jul 07 17:26:33 2022 +0200
+++ b/README.md	Thu Aug 18 20:12:22 2022 +0200
@@ -34,4 +34,15 @@
 
 ## Backing up
 
-Not sure how well Lucene, and the way I use it, guards against corruption. So I recommend making backups of the `Database` folder from time to time.
\ No newline at end of file
+Not sure how well Lucene, and the way I use it, guards against corruption. So I recommend making backups of the `Database` folder from time to time.
+
+## Compiling / Packaging
+
+Scripts have the extension 'gui_sh' for my convenience, but they're just regular shell scripts. Use 'run.gui_sh' to run the program for development, and 'package.gui_sh' to compile it into a JAR and package everything into a TAR archive. The resulting program should be able to run on any operating system with Java available. Currently run scripts are provided for Linux and Windows.
+
+To run from source and package, you need:
+ - Java runtime and Java compiler.
+ - 'tar' command.
+
+To run packaged version you need:
+ - Java runtime.