Mercurial Hosting > junotu
comparison README.md @ 35:8cc09761cf18
Added 'Compiling / Packaging' section to the README file
| author | Fox |
|---|---|
| date | Thu, 18 Aug 2022 20:12:22 +0200 |
| parents | 03fb5ab2e0a6 |
| children | 27f2a22399d1 |
comparison
equal
deleted
inserted
replaced
| 34:06b4a235d4bc | 35:8cc09761cf18 |
|---|---|
| 33 You can just type words for searches to return matches in title and content. If you want to search tags you can use `tag:value` or `tag:*` syntax. For more, see this: https://lucene.apache.org/core/3_0_3/queryparsersyntax.html | 33 You can just type words for searches to return matches in title and content. If you want to search tags you can use `tag:value` or `tag:*` syntax. For more, see this: https://lucene.apache.org/core/3_0_3/queryparsersyntax.html |
| 34 | 34 |
| 35 ## Backing up | 35 ## Backing up |
| 36 | 36 |
| 37 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. | 37 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. |
| 38 | |
| 39 ## Compiling / Packaging | |
| 40 | |
| 41 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. | |
| 42 | |
| 43 To run from source and package, you need: | |
| 44 - Java runtime and Java compiler. | |
| 45 - 'tar' command. | |
| 46 | |
| 47 To run packaged version you need: | |
| 48 - Java runtime. |
