[doc] rearrange and improve README #17
Conversation
| 1. `git clone https://github.com/exist-db/exist-xqts-runner.git` | ||
| 2. `cd exist-xqts-runner` | ||
| 3. `sbt compile` | ||
| In your local checkout of eXistdb run: |
There was a problem hiding this comment.
This only needs to be done if you want to use custom artifacts. Otherwise they are pulled from Maven Central. I think these steps needed for compiling and installing eXist-db artifacts need to be labelled as Optional.
There was a problem hiding this comment.
Well, yes and no. I would argue that running it against a development version is the common use-case.
There was a problem hiding this comment.
I would even argue that the version target should be promoted to a command line argument.
|
|
||
| ### Packaging the Application from Compiled Source | ||
| * If you require a standard Jar file for some purpose you can run `sbt package`, which will generate `target/scala-2.13/exist-xqts-runner_2.13-1.0.0.jar`. | ||
| - `target/scala-2.13/exist-xqts-runner-assembly-1.0.0.jar` |
There was a problem hiding this comment.
Previously the bit about the --help flag came before this. I think we still need to talk about --help otherwise users won't know what to run.
There was a problem hiding this comment.
In my experience the assembled jar was the only useful output.
Maybe it is better to give the standard jar its own section further below along with the --help flag. It would be cool if you would add that section as you are likely the best one to describe what you would use it for.
closes #14