<commit_before>== CarCV

image:https://travis-ci.org/oskopek/carcv.svg?branch=develop["Build Status", link="https://travis-ci.org/oskopek/carcv"]
image:https://coveralls.io/repos/oskopek/carcv/badge.png?branch=develop["Coverage status", link="https://coveralls.io/r/oskopek/carcv?branch=develop"]
image:https://www.ohloh.net/p/carcv/widgets/project_thin_badge.gif["Ohloh widget", link="https://www.ohloh.net/p/carcv"]

A car recognizing and speed calculation platform.

=== Screenshot
image:http://cdn.imghack.se/images/a6f3be78f72232fa6e9f09a11c53f7a6.png["CarCV screenshot", scalewidth="20%"]

=== Modules
CarCV consists of several modules:

* *carcv-core* -- core detection and recognition module
* *carcv-cpp* -- an old and deprecated implementation of this project in C++ with heavy use of OpenCV
* *carcv-webapp* -- a Java EE web-app implementation of the CarCV Core

CarCV uses http://semver.org/[semantic versioning] and a branching model similar to http://nvie.com/posts/a-successful-git-branching-model/[this].

=== 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-it+
* To *clean*, run: +mvn clean+
* Run a simple link:./docs/core/core-usage.adoc[carcv-core demo]

=== Getting help

* Join our *IRC channel*: Join *#carcv* on *irc.freenode.net*
* https://github.com/oskopek/carcv/issues[Open an issue] with your request/question (tag it with the *question* tag)

=== Contributing
*Everyone* is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using alpha, beta, and pre-release versions
* by reporting bugs
* by suggesting new features
* by implementing link:./docs/goals.adoc[planned features]
* by translating to a new language
* by link:./docs/howto-write-documentation.adoc[writing or editing documentation]
* by writing specifications
* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by closing https://github.com/oskopek/carcv/issues[issues]
* by reviewing patches

=== Submitting an Issue
We use the https://github.com/oskopek/carcv/issues[GitHub issue tracker] to track bugs and features. Before
submitting a bug report or feature request, check to make sure it hasn't
already been submitted. When submitting a bug report, please include a https://gist.github.com/[Gist]
that includes a stack trace and any details that may be necessary to reproduce
the bug, including your Java version and operating system.<commit_msg>Added Getting Help section to README<commit_after>== CarCV

image:https://travis-ci.org/oskopek/carcv.svg?branch=develop["Build Status", link="https://travis-ci.org/oskopek/carcv"]
image:https://coveralls.io/repos/oskopek/carcv/badge.png?branch=develop["Coverage status", link="https://coveralls.io/r/oskopek/carcv?branch=develop"]
image:https://www.ohloh.net/p/carcv/widgets/project_thin_badge.gif["Ohloh widget", link="https://www.ohloh.net/p/carcv"]

A car recognizing and speed calculation platform.

=== Screenshot
image:http://cdn.imghack.se/images/a6f3be78f72232fa6e9f09a11c53f7a6.png["CarCV screenshot", scalewidth="20%"]

=== Modules
CarCV consists of several modules:

* *carcv-core* -- core detection and recognition module
* *carcv-cpp* -- an old and deprecated implementation of this project in C++ with heavy use of OpenCV
* *carcv-webapp* -- a Java EE web-app implementation of the CarCV Core

CarCV uses http://semver.org/[semantic versioning] and a branching model similar to http://nvie.com/posts/a-successful-git-branching-model/[this].

=== 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-it+
* To *clean*, run: +mvn clean+
* Run a simple link:./docs/core/core-usage.adoc[carcv-core demo]

=== Getting help

* Post questions or comments on our Google Groups link:https://groups.google.com/d/forum/carcv[mailing list]
* Join our *IRC channel*: Join *#carcv* on *irc.freenode.net*

=== Contributing
*Everyone* is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using alpha, beta, and pre-release versions
* by reporting bugs
* by suggesting new features
* by implementing link:./docs/goals.adoc[planned features]
* by translating to a new language
* by link:./docs/howto-write-documentation.adoc[writing or editing documentation]
* by writing specifications
* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by closing https://github.com/oskopek/carcv/issues[issues]
* by reviewing patches

=== Submitting an Issue
We use the https://github.com/oskopek/carcv/issues[GitHub issue tracker] to track bugs and features. Before
submitting a bug report or feature request, check to make sure it hasn't
already been submitted. When submitting a bug report, please include a https://gist.github.com/[Gist]
that includes a stack trace and any details that may be necessary to reproduce
the bug, including your Java version and operating system.
{'fraction_non_alphanumeric': 0.12192454893384364, 'fraction_numerical': 0.007654455986878075, 'mean_word_length': 5.017543859649122, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 20, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4278115', 'n_tokens_mistral': 1804, 'n_tokens_neox': 1717, 'n_words': 540}