Skip to content

Commit b8b380e

Browse files
committed
Add usage instructions.
1 parent d9005bc commit b8b380e

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Face Detection + Auto Labelling
1+
Face Detection + Auto Labelling (Alpha version)
22
====================
33

44
Face Detection on school year group photo and automatic labelling.
@@ -10,12 +10,20 @@ Face Detection on school year group photo and automatic labelling.
1010
href="http://creativecommons.org/licenses/by-sa/3.0">CC BY-SA 3.0</a> via <a href="https://commons.wikimedia.org/wiki/">Wikimedia Commons</a>.
1111

1212

13+
## Usage
14+
- File > Open: Open a dialog to select the desired images
15+
- When an image is loaded, a double left click will delete (after a confirmation) the label located under the mouse cursor (known issue: it is sometimes buggy, retry multiple times).
16+
- When an image is loaded, a right click will add a label. A dialog will show and ask for the label number.
17+
- Use the "<" and ">" buttons to load the previous and next images.
18+
- File > Save to directory: Open a dialog to select the directory where will be saved the images. If a file with the same name already exists, it will be asked if we want to overwrite or not the file.
19+
20+
1321
## Development environment
1422
- Windows 7 64 bits
1523
- Visual Studio 2010
1624
- OpenCV 2.4.10
1725
- Qt 5.5.0
18-
- binarie compiled in 32 bits release mode
26+
- binarie(Alpha version) compiled in 32 bits release mode
1927

2028

2129
## Known issues
@@ -25,3 +33,4 @@ href="http://creativecommons.org/licenses/by-sa/3.0">CC BY-SA 3.0</a> via <a hre
2533
## TODO
2634
- [ ] Add a setting dialog to allow the modification of some parameters (Cascade classifier learning file, size of the label box, etc.)
2735
- [ ] Try to find a way to use more classical fonts than those provided by OpenCV
36+
- [ ] Try to find a way to display a better image than the raw RGB888

0 commit comments

Comments
 (0)