Skip to content

Commit 39a6b24

Browse files
authored
Base Setup of README.md
Setup the README.md with table of contents, headers, and some base information.
1 parent 8209fe0 commit 39a6b24

1 file changed

Lines changed: 101 additions & 27 deletions

File tree

README.md

Lines changed: 101 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,103 @@
1+
NOTE: CSV data files for training and testing data must be added to project folder manually due to file sizes.
2+
13
# Audible ON
4+
5+
***
26
## Table of Contents
3-
1. [Project Overview](https://github.com/Capstone-Projects-2022-Spring/project-audibleon/edit/main/README.md#project-overview)
4-
2. [Contributors](https://github.com/Capstone-Projects-2022-Spring/project-audibleon/edit/main/README.md#contributors)
5-
6-
### Project Overview
7-
Audible ON is an application that utilizes the client’s camera on their device to record
8-
and translate gestures from the American Sign Language (ASL) into legible text, as well as speech. Both hearing
9-
impaired and non-hearing impaired clients will be able to use this application to communicate
10-
with one another in a variety of situations. Audible ON utilizes several other libraries and
11-
computing systems such as Google MediaPipe and a Convolutional Neural Network (CNN) to
12-
add additional features that will allow user flexibility.
13-
14-
As technology and medicine advance each year, communication between hearing
15-
impaired and non-hearing impaired individuals needs improvement to communicate. Audible ON
16-
seeks to allow both groups to communicate with each other without the need for an interpreter.
17-
Audible ON’s goal is to allow the hearing impaired to assimilate into society easier by
18-
communicating with the general public just as easily as the general public communicate with
19-
each other without the need for a live interpreter.
20-
21-
NOTE: CSV data files for training and testing data must be added to project folder manually due to file sizes.
22-
23-
### Contributors
24-
- Ben Westburg
25-
- Juan-Carlo Villamor Mercado
26-
- Rachel Lazzaro
27-
- Raymond Laubert
28-
- Mahmood Ahmed
29-
- Shakirah Cooper
7+
1. [Project Overview](#project-overview)
8+
* [Our Vision](#our-vision)
9+
* [Personas and Key Features](#personas-features)
10+
2. [Hello World](#hello-world)
11+
3. [Technologies](#technologies)
12+
4. [New Releases](#new-releases)
13+
* [How to Download and Install New Release](#download-install-release)
14+
* [How to Run New Release](#run-release)
15+
5. [Team Contributions](#team-contributions)
16+
* [Meet Our Team](#team)
17+
* [Contributions](#contributions)
18+
6. [UML Diagrams](#uml-dia)
19+
* [Class Diagram](#class-dia)
20+
* [Sequence Diagram](#seq-dia)
21+
7. [Resources](#resources)
22+
23+
24+
25+
***
26+
<a name = "project-overview"></a>
27+
## Project Overview
28+
Audible ON is an application that utilizes the client’s camera on their device to record and translate gestures from the American Sign Language (ASL) into legible text and/or audible speech, and vice versa (from either text or speech to ASL). Both hearing impaired and non-hearing impaired clients will be able to use this application to communicate with one another in a variety of situations. Audible ON utilizes several other libraries and computing systems such as Google MediaPipe and a Convolutional Neural Network (CNN) to add additional features that will allow user flexibility. Such features will be listed below in the features list.
29+
30+
As technology and medicine advance each year, communication between hearing impaired and non-hearing impaired individuals needs improvement to communicate. Audible ON seeks to allow both groups to communicate with each other without the need for an interpreter. Audible ON’s goal is to allow the hearing impaired to assimilate into society easier by communicating with the general public just as easily as the general public communicates with each other without the need for a live interpreter.
31+
32+
33+
<a name = "our-vision"></a>
34+
### Our Vision
35+
36+
<a name = "personas-features"></a>
37+
### Personas and Key Features
38+
39+
***
40+
<a name = "hello-world"></a>
41+
## ASL Alphabet Detector
42+
43+
44+
### Limitations
45+
* Programmed exclusively for the left hand
46+
47+
***
48+
<a name = "technologies"></a>
49+
## Technologies
50+
* Jupyter Notebook
51+
52+
### Libraries
53+
* Google's MediaPipe
54+
* Keras
55+
* NumPy
56+
* OpenCV
57+
* Time
58+
59+
***
60+
<a name = "new-releases"></a>
61+
## New Releases
62+
63+
<a name = "download-install-release"></a>
64+
### How to Download and Install New Release
65+
66+
67+
<a name = "run-release"></a>
68+
### How to Run New Release
69+
70+
71+
***
72+
<a name = "team-contributions"></a>
73+
## Team Contributions
74+
75+
<a name = "team"></a>
76+
### Meet Our Team
77+
#### [Shakirah D. Cooper](https://github.com/ArchaePi)
78+
#### [Rachel Lazzaro](https://github.com/rlazz)
79+
#### [Ben Westburg](https://github.com/tun60968)
80+
#### [Mahmood Ahmed](https://github.com/RaymondLaubert)
81+
#### [Juan-Carlo Villamor Mercado](https://github.com/JC-127)
82+
#### [Raymond Laubert](https://github.com/MoodAhmed)
83+
84+
<a name = "contributions"></a>
85+
### Contributions
86+
87+
***
88+
<a name = "uml-dia"></a>
89+
## UML Diagrams
90+
91+
<a name = "class-dia"></a>
92+
### Class Diagram
93+
94+
<a name = "seq-dia"></a>
95+
### Sequence Diagram
96+
97+
***
98+
99+
<a name = "resources"></a>
100+
## Resources
101+
https://google.github.io/mediapipe/solutions/hands.html </br>
102+
https://github.com/google/mediapipe/ </br>
103+
***

0 commit comments

Comments
 (0)