Skip to content

Commit 6334ab9

Browse files
committed
Feat(README.md): Update README
Author: Ziyuan Chen (Simon Chen)
1 parent da07cff commit 6334ab9

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
11
# Algorithms in Action
22

3+
![license](https://img.shields.io/badge/license-MIT-Green) ![node](https://img.shields.io/badge/node-v18.17.1-blue) ![npm](https://img.shields.io/badge/npm-v9.6.7-blue)
4+
35
Welcome to Algorithms In Action!
46

57
Here is the [entry](https://algorithms-in-action.github.io/) for the algorithm visualiser.
68

79
You may want to read the [WIKI](https://github.com/algorithms-in-action/algorithms-in-action.github.io/wiki) for more project details.
810

9-
[toc]
11+
- [Algorithms in Action](#algorithms-in-action)
12+
- [Project Description](#project-description)
13+
- [Development History](#development-history)
14+
- [Developer](#developer)
15+
- [Start Up](#start-up)
16+
- [Deployment](#deployment)
17+
- [Environment Setup](#environment-setup)
18+
- [Install Dependencies](#install-dependencies)
19+
- [Start a local server](#start-a-local-server)
20+
- [Branch Management](#branch-management)
21+
- [Folder Organisation](#folder-organisation)
22+
- [License](#license)
1023

1124
## Project Description
1225

13-
Algorithms in Action (AIA) is an animation software tool, developed for the purposes of teaching computer science algorithms by Linda Stern, Lee Naish, and Harald Søndergaard at The University of Melbourne. AIA features animation, pseudocode, and textual explanations, run in coordinated fashion. A key feature of AIA, not found in other algorithm animations, is that students can view an algorithm at varying levels of detail. Starting with a high level pseudocode description of the algorithm, with accompanying high level animation and textual explanation, students can expand sections of the pseudocode to expose more detail. Animation and explanation are controlled in coordinate fashion, becoming correspondingly more detailed as the pseudocode is expanded. The rationale for various features of AIA and results from students using the program were reported in [1].
26+
Algorithms in Action (AIA) is an animation software tool, developed for the purposes of teaching computer science algorithms by Linda Stern, Lee Naish, and Harald Søndergaard at The University of Melbourne. AIA features animation, pseudocode, and textual explanations, run in coordinated fashion. A key feature of AIA, not found in other algorithm animations, is that students can view an algorithm at varying levels of detail. Starting with a high level pseudocode description of the algorithm, with accompanying high level animation and textual explanation, students can expand sections of the pseudocode to expose more detail. Animation and explanation are controlled in coordinate fashion, becoming correspondingly more detailed as the pseudocode is expanded. The rationale for various features of AIA and results from students using the program were reported in the paper <sup>[1]</sup>.
1427

1528
> [1] Stern, L., Søndergaard, and Naish, L., A Strategy for Managing Content Complexity in Algorithm Animation, *Proceedings of the Fourth Annual SIGCSE/SIGCUE Conference on Innovation and* *Technology in Computer Science Education (ITiCSE99),* Cracow, Poland, ACM Press, 127-130, 1999.
1629
@@ -78,9 +91,11 @@ You may need to check the WIKI for the [development manual](https://github.com/a
7891

7992
### Folder Organisation
8093

81-
- src/\: Source code of the web app.
82-
- ui/\: Contains all the images and graphics used for the project.
94+
| Name | Description |
95+
| ----- | ---------------------------------------------------------- |
96+
| ./src | Source code of the web app. |
97+
| ./ui | Contains all the images and graphics used for the project. |
8398

8499
## License
85100

86-
Algorithms-in-action/algorithms-in-action.github.io is licensed under the MIT License, a short and simple permissive license with conditions only requiring preservation of copyright and license notices.
101+
Algorithms-in-action/algorithms-in-action.github.io is licensed under the MIT License, a short and simple permissive license with conditions only requiring preservation of copyright and license notices.

0 commit comments

Comments
 (0)