diff --git a/README.md b/README.md index abb2505d1..f2bdce4d0 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,17 @@ This is a Julia implementation of [Viola-Jones' Object Detection algorithm](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.10.6807). Although there is an [OpenCV port in Julia](https://github.com/JuliaOpenCV/OpenCV.jl), it seems to be ill-maintained. As this algorithm was created for commercial use, there seem to be few widely-used or well-documented implementations of it on GitHub. The implementation this repository is based off is [Simon Hohberg's Pythonic repository](https://github.com/Simon-Hohberg/Viola-Jones), as it seems to be well written (amd the most starred Python implementation on GitHub, though this is not necessarily a good measure), and Julia and Python alike are easy to read and write in — my thinking was that this would be easy enough to replicate in Julia, except for Pythonic classes, where I would have to use `struct`s (or at least easier to replicate from than, for example, [C++](https://github.com/alexdemartos/ViolaAndJones) or [JS](https://github.com/foo123/HAAR.js) — two other hgihly-starred repositories.). + +## Installation and Set Up + +Run the following in terminal: +```bash +cd ${HOME} +git clone https://github.com/jakewilliami/FaceDetection.jl.git/ +cd FaceDetection.jl +bash setup.sh +``` + ## How it works In an over-simplified manner, the Viola-Jones algorithm has some four stages: @@ -21,11 +32,3 @@ In an over-simplified manner, the Viola-Jones algorithm has some four stages: 4. Finally, this algorithm uses [Cascading Classifiers](https://en.wikipedia.org/wiki/Cascading_classifiers) to identify faces. (See page 12 of the original paper for the specific cascade). For a better explanation, read [the paper from 2001](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.10.6807), or see [the Wikipedia page](https://en.wikipedia.org/wiki/Viola%E2%80%93Jones_object_detection_framework) on this algorithm. - -## Setting Up - -Run in Terminal -``` -chmod u+x setup.sh -./setup.sh -```