Skip to content

Commit

Permalink
Minor fixes to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
optionsome committed Oct 15, 2024
1 parent 6b3ba97 commit 6cb05b1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@ We run a speed test (included in the code) to measure the performance for every

## Repository layout

The main Java server code is in `src/main/`. OTP also includes a Javascript client based on the
Leaflet mapping library in `src/client/`. This client is now primarily used for testing, with most
major deployments building custom clients from reusable components. The Maven build produces a
unified ("shaded") JAR file at `target/otp-VERSION.jar` containing all necessary code and
dependencies to run OpenTripPlanner.
The main Java server code is in `application/src/main/`. OTP also includes a Javascript client based on the
MapLibre mapping library in `client/src/`. This client is now used for testing, with most major
deployments building custom clients from reusable components. The Maven build produces a unified ("shaded")
JAR file at `application/target/otp-VERSION.jar` containing all necessary code and dependencies to run OpenTripPlanner.

Additional information and instructions are available in
the [main documentation](http://docs.opentripplanner.org/en/dev-2.x/), including a
Expand Down
14 changes: 7 additions & 7 deletions doc/user/Getting-OTP.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ OTP. If all goes well you should see a success message like the following:
[INFO] ------------------------------------------------------------------------
```

This build process should produce a JAR file called `otp-x.y.z-shaded.jar` in the `target/`
directory which contains all the compiled OTP classes and their dependencies (the external libraries
they use). The shell script called 'otp' in the root of the cloned repository will start the main
class of that JAR file under a Java virtual machine, so after the Maven build completes you should
be able to run `./otp --help` and see an OTP help message including command line options. Due to the
way Maven works, this script is not executable by default, so you will need to do `chmod u+x ./otp`
before you run it to mark it as executable.
This build process should produce a JAR file called `otp-x.y.z-shaded.jar` in the
`application/target/` directory which contains all the compiled OTP classes and their dependencies
(the external libraries they use). The shell script called 'otp' in the root of the cloned repository
will start the main class of that JAR file under a Java virtual machine, so after the Maven build
completes you should be able to run `./otp --help` and see an OTP help message including command line
options. Due to the way Maven works, this script is not executable by default, so you will need to do
`chmod u+x ./otp` before you run it to mark it as executable.

The words "clean package" are the build steps you want to run. You're telling maven to clean up any
extraneous junk in the directory, then perform all the build steps, including compilation, up to and
Expand Down

0 comments on commit 6cb05b1

Please sign in to comment.