Skip to content

Commit 52da5ee

Browse files
authored
Update README.md
1 parent 792a15f commit 52da5ee

File tree

1 file changed

+59
-62
lines changed

1 file changed

+59
-62
lines changed

README.md

Lines changed: 59 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/acaa3eb255b84676acc52402a39e7e07)](https://www.codacy.com/app/Giulianini/Jestures?utm_source=github.com&utm_medium=referral&utm_content=Giulianini/Jestures&utm_campaign=Badge_Grade)
33
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/acaa3eb255b84676acc52402a39e7e07)](https://www.codacy.com/app/Giulianini/Jestures?utm_source=github.com&utm_medium=referral&utm_content=Giulianini/Jestures&utm_campaign=Badge_Coverage)
44
[![PyPI - License](https://img.shields.io/github/license/Giulianini/Jestures.svg)](https://github.com/Giulianini/Jestures/blob/master/LICENSE.txt)
5-
[ ![Download](https://api.bintray.com/packages/giulianini/maven/Jestures/images/download.svg?version=0.0.2) ](https://bintray.com/giulianini/maven/Jestures/0.0.2/link)
5+
[ ![Download](https://api.bintray.com/packages/giulianini/maven/Jestures/images/download.svg?version=0.0.2) ](https://bintray.com/giulianini/maven/Jestures/0.0.2/link)
66
[![Maven Central](https://img.shields.io/maven-central/v/com.github.giulianini.jestures/jestures.svg)](https://search.maven.org/search?q=g:com.github.giulianini.jestures)
77
[![Javadocs](https://www.javadoc.io/badge/com.github.giulianini.jestures/jestures.svg)](https://www.javadoc.io/doc/com.github.giulianini.jestures/jestures)
88
![GitHub issues](https://img.shields.io/github/issues/Giulianini/Jestures.svg)
@@ -15,7 +15,7 @@
1515

1616
# Jestures
1717

18-
## A simple framework for gesture recognition in Java.
18+
## A simple framework for gesture recognition in Java
1919

2020
<h1 align="center">
2121
<img src="/pic/Jestures.png">
@@ -25,9 +25,9 @@
2525
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/LucaGiulianini?locale.x=it_IT)
2626

2727
## Download
28-
* Released builds are available from - [Bintray](https://bintray.com/giulianini/maven/Jestures/_latestVersion)
29-
* Released builds are available from - [Maven Central](https://search.maven.org/search?q=g:com.github.giulianini.jestures)
30-
* Snapshot builds are available from - [Artifactory](http://oss.jfrog.org/oss-snapshot-local/com/github/giulianini/jestures/)
28+
* Released builds are available from - [Bintray](https://bintray.com/giulianini/maven/Jestures/_latestVersion)
29+
* Released builds are available from - [Maven Central](https://search.maven.org/search?q=g:com.github.giulianini.jestures)
30+
* Snapshot builds are available from - [Artifactory](http://oss.jfrog.org/oss-snapshot-local/com/github/giulianini/jestures/)
3131

3232
## Javadocs
3333
If you need to access the documentation for any stable version, [javadoc.io](https://www.javadoc.io/doc/com.github.giulianini.track4j/track4j/) is probably the right place to search in.
@@ -57,14 +57,14 @@ Run the demo with:
5757
#### How to Include In Gradle Project
5858
```gradle
5959
repositories {
60-
mavenCentral()
61-
jCenter()
60+
mavenCentral()
61+
jCenter()
6262
}
6363
```
6464
Reference the repository from this location using:
6565
```gradle
6666
dependencies {
67-
compile 'com.github.giulianini.jestures:jestures:1.0.0'
67+
compile 'com.github.giulianini.jestures:jestures:1.0.0'
6868
}
6969
```
7070

@@ -73,10 +73,10 @@ dependencies {
7373
#### How to Include In Maven Project
7474
```xml
7575
<dependency>
76-
<groupId>com.github.giulianini.jestures</groupId>
77-
<artifactId>jestures</artifactId>
78-
<version>1.0.0</version>
79-
<type>pom</type>
76+
<groupId>com.github.giulianini.jestures</groupId>
77+
<artifactId>jestures</artifactId>
78+
<version>1.0.0</version>
79+
<type>pom</type>
8080
</dependency>
8181
```
8282

@@ -85,24 +85,24 @@ dependencies {
8585
#### How to Include In Ivy Project
8686
```xml
8787
<dependency org='com.github.giulianini.jestures' name='jestures' rev='1.0.0'>
88-
<artifact name='jestures' ext='pom' ></artifact>
88+
<artifact name='jestures' ext='pom' ></artifact>
8989
</dependency>
9090
```
9191

92-
## How can I use Jestures?
92+
## How can I use Jestures
9393

9494
### Set Up The Framework
95-
1. Install the [__Kinect SDK__ ](https://www.microsoft.com/en-us/download/confirmation.aspx?id=40278)
96-
1. Download natives - [Natives dll for Kinect](https://drive.google.com/open?id=1Dpvs71O2dN6AxnTrMUGLAIDJkp0y8YXD)
97-
1. Put __ufdw_j4k_**bit.dll_ Natives into __HOME/.Jestures/native__. Jestures will find them.
98-
1.
99-
* **Build**
95+
1. Install the [__Kinect SDK__ ](https://www.microsoft.com/en-us/download/confirmation.aspx?id=40278)
96+
2. Download natives - [Natives dll for Kinect](https://drive.google.com/open?id=1Dpvs71O2dN6AxnTrMUGLAIDJkp0y8YXD)
97+
3. Put __ufdw_j4k_**bit.dll_ Natives into __HOME/.Jestures/native__. Jestures will find them.
98+
4.
99+
* **Build**
100100
You can download the source code of the library and build it as mentioned previously. Building Jestures will generate Jestures.jar under the Track4J/build/libs folder. To use Jestures, import Jestures.jar into your project and start recognizing gestures :).
101-
* **Import the dependency**
101+
* **Import the dependency**
102102
Include the dependency for your build system.
103103

104104
### Start The Recorder Tool
105-
1. Follow the step above and the recorder tool must work with your kinect version.
105+
5. Follow the step above and the recorder tool must work with your kinect version.
106106

107107
### Code
108108

@@ -138,7 +138,7 @@ dependencies {
138138
#### Define your own UI
139139

140140
```java
141-
public class Gui extends AbstractView {
141+
public class Gui extends AbstractView {
142142
public Gui(Recognition recognizer) {
143143
super(recognizer);
144144
// TODO Auto-generated constructor stub
@@ -155,64 +155,61 @@ dependencies {
155155
}
156156
```
157157

158-
159158
## Supported sensors
160159

161-
* **Windows:**
160+
* **Windows:**
162161
- _Kinect v1_
163162
- _Kinect v2_
164163

165164
### Future support
166165

167-
* **Windows:**
166+
* **Windows:**
168167
- _Lipmotion_
169168

170-
* **Linux:**
169+
* **Linux:**
171170
- _Kinect v1_
172171
- _Kinect v2_
173172

174-
175-
176173
## Notes for Developers
177174

178175
### Importing the project
179176
The project has been developed using Eclipse, and can be easily imported in such IDE.
180177

181178
#### Recommended configuration
182-
* Install the required eclipse plugins:
183-
* In Eclipse, click "Help" -> "Eclipse Marketplace..."
184-
* In the search field enter "findbugs", then press Enter
185-
* One of the retrieved entries should be "FindBugs Eclipse Plugin", click Install
186-
* Click "< Install More"
187-
* In the search field enter "checkstyle", then press Enter
188-
* One of the retrieved entries should be "Checkstyle Plug-in" with a written icon whose text is "eclipse-cs", click Install
189-
* Click "< Install More"
190-
* Wait for Eclipse to resolve all the features
191-
* Click "Confirm >"
192-
* Follow the instructions, accept the license, wait for Eclipse to download and install the product, accept the installation and restart the IDE
193-
* When restarted, click "Help" -> "Install New Software..."
194-
* Click "Add..."
195-
* In "Location" field, enter `https://dl.bintray.com/pmd/pmd-eclipse-plugin/updates/`
196-
* The "Name" field is not mandatory (suggested: "PMD")
197-
* Click OK.
198-
* If not already selected, in "Work with:" dropdown menu choose the just added update site
199-
* Select "PMD for Eclipse 4" and click next
200-
* Follow the instructions, accept the license, wait for Eclipse to download and install the product, accept the installation and restart the IDE.
201-
* Set the line delimiter to LF (only for Windows users)
202-
* In Eclipse, click window -> preferences
203-
* In the search form enter "encoding", then press Enter
204-
* Go to General -> Workspace
205-
* In the section "New text file line delimiter" check "Other" and choose Unix
206-
* Apply
207-
* Use space instead of tabs
208-
* In Eclipse, click window -> preferences
209-
* Go to General -> Editors -> Text Editors
210-
* Check "insert spaces for tabs" option.
211-
* Apply.
212-
* Go to Java -> Code style -> Formatter
213-
* Click Edit button
214-
* In Indentation tab, under "General Settings", set "tab policy" to "Spaces only"
215-
* Apply (you should probably rename the formatter settings).
179+
* Install the required eclipse plugins:
180+
* In Eclipse, click "Help" -> "Eclipse Marketplace..."
181+
* In the search field enter "findbugs", then press Enter
182+
* One of the retrieved entries should be "FindBugs Eclipse Plugin", click Install
183+
* Click "< Install More"
184+
* In the search field enter "checkstyle", then press Enter
185+
* One of the retrieved entries should be "Checkstyle Plug-in" with a written icon whose text is "eclipse-cs", click Install
186+
* Click "< Install More"
187+
* Wait for Eclipse to resolve all the features
188+
* Click "Confirm >"
189+
* Follow the instructions, accept the license, wait for Eclipse to download and install the product, accept the installation and restart the IDE
190+
* When restarted, click "Help" -> "Install New Software..."
191+
* Click "Add..."
192+
* In "Location" field, enter `https://dl.bintray.com/pmd/pmd-eclipse-plugin/updates/`
193+
* The "Name" field is not mandatory (suggested: "PMD")
194+
* Click OK.
195+
* If not already selected, in "Work with:" dropdown menu choose the just added update site
196+
* Select "PMD for Eclipse 4" and click next
197+
* Follow the instructions, accept the license, wait for Eclipse to download and install the product, accept the installation and restart the IDE.
198+
* Set the line delimiter to LF (only for Windows users)
199+
* In Eclipse, click window -> preferences
200+
* In the search form enter "encoding", then press Enter
201+
* Go to General -> Workspace
202+
* In the section "New text file line delimiter" check "Other" and choose Unix
203+
* Apply
204+
* Use space instead of tabs
205+
* In Eclipse, click window -> preferences
206+
* Go to General -> Editors -> Text Editors
207+
* Check "insert spaces for tabs" option.
208+
* Apply.
209+
* Go to Java -> Code style -> Formatter
210+
* Click Edit button
211+
* In Indentation tab, under "General Settings", set "tab policy" to "Spaces only"
212+
* Apply (you should probably rename the formatter settings).
216213

217214
## Screenshots
218215
### Recognition

0 commit comments

Comments
 (0)