Permalink
Browse files

Update documentation

  • Loading branch information...
shred committed Feb 3, 2016
1 parent 3b548c3 commit 50def3dff4a90b86cdd27e41b477fb94568c9136
Showing with 6 additions and 8 deletions.
  1. +3 −5 README.md
  2. +3 −3 src/site/markdown/index.md.vm
View
@@ -1,6 +1,6 @@
# PdbConverter
-_PdbConverter_ is a too for converting PalmOS PDB files into more common file formats.
+_PdbConverter_ is a tool for converting PalmOS PDB files into more common file formats.
![Screenshot](./src/site/resources/img/screenshot.png)
@@ -17,16 +17,14 @@ _PdbConverter_ is a too for converting PalmOS PDB files into more common file fo
## Usage
-Just run the compiled jar file:
+Please install [Java](http://java.com), then download the latest precompiled jar from [GitHub](https://github.com/shred/pdbconverter/releases/) and run it:
```
-java -jar target/pdbconverter.jar --gui
+java -jar pdbconverter.jar --gui
```
See the [online documentation](http://www.shredzone.org/maven/pdbconverter/) for further details.
-I have been providing a WebStart version and also a converter web site for some years. These sites have been closed because even though there were hundreds of visitors every month, not a single one felt obliged to give a small donation for it.
-
## License
_PdbConverter_ is distributed under [Gnu Public License v3](http://www.gnu.org/licenses/gpl-3.0.html).
@@ -1,7 +1,7 @@
pdbconverter
============
-_PdbConverter_ is a too for converting PalmOS PDB files into more common file formats.
+_PdbConverter_ is a tool for converting PalmOS PDB files into more common file formats.
![Screenshot](./img/screenshot.png)
@@ -10,10 +10,10 @@ The source code can be found at [GitHub](https://github.com/shred/pdbconverter)
Usage
-----
-Just run the compiled jar file:
+Please install Java, then download the latest precompiled jar from [GitHub](https://github.com/shred/pdbconverter/releases/) and run it:
```
-java -jar target/pdbconverter.jar --gui
+java -jar pdbconverter.jar --gui
```
There is also a command line interface. You will get help if you omit the `--gui` option.

0 comments on commit 50def3d

Please sign in to comment.