Skip to content

Commit

Permalink
Merge pull request #68 from brettch/usage-docs
Browse files Browse the repository at this point in the history
Usage docs
  • Loading branch information
migurski committed Jun 2, 2020
2 parents fb5f1e5 + 7039399 commit b2ce686
Show file tree
Hide file tree
Showing 3 changed files with 3,072 additions and 50 deletions.
60 changes: 10 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ file, components for deriving and applying change sets to data sources,
components for sorting data, etc. It has been written so that it is easy to add
new features without re-writing common tasks such as file or database handling.

Some brief build, running and installation notes are provided below, however
most documentation may be found on
[the project wiki page](http://wiki.openstreetmap.org/wiki/Osmosis).
The main point of entry for documentation is
[the project wiki page](http://wiki.openstreetmap.org/wiki/Osmosis), although
some information is included below.

## Status

Expand All @@ -25,6 +25,12 @@ and transitioned to periodic acceptance of pull requests with tests and minor ve
Keep an eye on [osmosis-dev list](https://lists.openstreetmap.org/listinfo/osmosis-dev)
for any updates.

## Usage

* [The project wiki page](http://wiki.openstreetmap.org/wiki/Osmosis) is the best
place to begin for new users.
* [Detailed Usage](./doc/detailed-usage.adoc) is the main reference for experienced users.

## Installation

It is recommended to use a pre-built distribution archive rather than compile
Expand All @@ -37,53 +43,7 @@ already on the `PATH`.

## Development

The easiest way to perform a full Osmosis build is to use the docker-based
development environment. If you have docker and docker-compose installed,
simply run the following command to build and launch a shell with everything
required to run the full build and test suite.

./docker.sh

Osmosis is built using the [Gradle build tool](http://gradle.org). Gradle itself
does not need to be installed because the `gradlew` script will install Gradle on
first usage. The only requirements are a 1.7 JDK, and an Internet connection.
Note that in the docker environment all downloads will still occur and be cached
in your home directory.

Below are several commands useful to build the software. All commands must be
run from the root of the source tree.

Perform a complete build including unit tests:

./docker.sh ./gradlew build

Build the software without running unit tests:

./docker.sh ./gradlew assemble

Clean the build tree:

./docker.sh ./gradlew clean

Generate project files to allow the project to be imported into IntelliJ.

./docker.sh ./gradlew idea

Generate project files to allow the project to be imported into Eclipse.

./docker.sh ./gradlew eclipse

Verify checkstyle compliance:

./docker.sh ./gradlew checkstyleMain checkstyleTest

After completing the build process, a working Osmosis installation is contained
in the `package` sub-directory. The Osmosis launcher scripts reside in the `bin`
sub-directory of package. On a UNIX-like environment use the "osmosis" script,
on a Windows environment use the "osmosis.bat" script.

Distribution archives in zip and tar gzipped formats are contained in the
`package/build/distribution` directory.
See [Development](./doc/development.md) for details.

## Issue Tracking

Expand Down
Loading

0 comments on commit b2ce686

Please sign in to comment.