Skip to content

Commit

Permalink
Fixed readme syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
oskopek committed Dec 9, 2015
1 parent d26fb88 commit ae012f7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions README.adoc
Expand Up @@ -21,10 +21,10 @@ CarCV uses http://semver.org/[semantic versioning].
=== Building
* See: How-to setup your *build environment*:
link:./docs/howto-setup-environment-windows.adoc[Windows], link:./docs/howto-setup-environment-linux.adoc[Linux & Mac]
* *Recommended*: +mvn clean install -DskipTests+
* To run *unit tests*: +mvn clean install+
* To run *integration tests*: +mvn clean install -Pit,wildfly+
* To *clean*, run: +mvn clean+
* *Recommended*: `mvn clean install -DskipTests`
* To run *unit tests*: `mvn clean install`
* To run *integration tests*: `mvn clean install -Pit,wildfly`
* To *clean*, run: `mvn clean`
* Run a simple link:./docs/core/core-usage.adoc[carcv-core demo]

=== Docker
Expand Down Expand Up @@ -70,7 +70,7 @@ the bug, including your Java version and operating system.
. http://learn.github.com/p/branching.html[Create a topic branch]
. Implement your feature or bug fix
. If applicable, add tests for your feature or bug fix
. Run +mvn clean install -Pit+
. Run `mvn clean install -Pit`
.. If you contributed to *carcv-webapp*, run: `mvn clean install -Pit,wildfly-it`
. If the tests fail, return to step 3 and 4
. Add, commit, and push your changes
Expand Down
14 changes: 7 additions & 7 deletions docs/core/core-usage.adoc
Expand Up @@ -52,10 +52,10 @@ View the `.properties` files in `out` for results.

=== Using the default implementation of CarRecognizer

To use +carcv-core+ (number plate detection and speed detection) in your application,
simply instantiate a +FileCarRecognizer+ (the default implementation of +CarRecognizer+).
To use `carcv-core` (number plate detection and speed detection) in your application,
simply instantiate a `FileCarRecognizer` (the default implementation of `CarRecognizer`).

For example, in +carcv-webapp+ we use this method in +RecognizerBean+ like this:
For example, in `carcv-webapp` we use this method in `RecognizerBean` like this:

[source,java]
----
Expand All @@ -69,10 +69,10 @@ public class RecognizerBean {
}
----

This assumes you use a data input and output directory in a filesystem +java.nio+ can access.
This assumes you use a data input and output directory in a filesystem `java.nio` can access.

=== Using your own implementation of CarRecognizer

If you wish to implement it yourself, simply extend the +CarRecognizer+ abstract class.
Notes on implementation details are in the javadoc for +CarRecognizer+.
To see the default implementation, see the +org.carcv.impl+ packages.
If you wish to implement it yourself, simply extend the `CarRecognizer` abstract class.
Notes on implementation details are in the javadoc for `CarRecognizer`.
To see the default implementation, see the `org.carcv.impl` packages.

0 comments on commit ae012f7

Please sign in to comment.