Skip to content

Commit 1e66ac1

Browse files
committed
README update
1 parent 8395a9d commit 1e66ac1

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Algorithm Visualizer
2+
3+
By:
4+
[Sam Gotto](https://github.com/https-sam),
5+
[Michael Metz](https://github.com/MicMetz)
6+
<br>
7+
<br>
8+
<u>Languages</u> : [ReactJS](https://reactjs.org/)
9+
<br>
10+
<br>
11+
<u>Description</u> : The algorithm visualizer. This is a ReactJS web
12+
application that allows the user to visualize the implementation of
13+
a sorting algorithm.
14+
<br>
15+
<br>
16+
<ul style="padding: 0"><u>Requirements</u> :
17+
<li style="list-style: none"><ul><u>Functional</u> :
18+
<li style="list-style-type: circle; margin-left: 15px">Input Parsing</li>
19+
<li style="list-style-type: circle; margin-left: 15px">Input Validation</li>
20+
<li style="list-style-type: circle; margin-left: 15px">Accurate and faster algorithms</li>
21+
<li style="list-style-type: circle; margin-left: 15px"></li>
22+
<li style="list-style-type: circle; margin-left: 15px"></li>
23+
</ul></li>
24+
<br>
25+
<li style="list-style: none"><ul><u>System</u> :
26+
<li style="list-style-type: circle; margin-left: 15px">Web browser that is capable of running newer javascript code</li>
27+
</ul></li>
28+
<br>
29+
<li style="list-style: none"><ul><u>UX & Performance</u> :
30+
<li style="list-style-type: circle; margin-left: 15px">Use faster algorithms to avoid a potential crash when user input is large</li>
31+
<li style="list-style-type: circle; margin-left: 15px">Provide smooth animations</li>
32+
<li style="list-style-type: circle; margin-left: 15px">Provide option to change how fast the algorithm should perform</li>
33+
</ul></li>
34+
</ul>

0 commit comments

Comments
 (0)