You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-10Lines changed: 6 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@
4
4
5
5
Welcome to Algorithms In Action!
6
6
7
-
Here is the [entry](https://algorithms-in-action.github.io/)for the algorithm visualiser.
7
+
Here is the [link](https://algorithms-in-action.github.io/)to run the algorithm visualiser on your browser.
8
8
9
-
You may want to read the [WIKI](https://github.com/algorithms-in-action/algorithms-in-action.github.io/wiki) for more project details.
9
+
We recommend you read the [WIKI](https://github.com/algorithms-in-action/algorithms-in-action.github.io/wiki) for more project details.
10
10
11
11
-[Algorithms in Action](#algorithms-in-action)
12
12
-[Project Description](#project-description)
@@ -29,13 +29,9 @@ Algorithms in Action (AIA) is an animation software tool, developed for the purp
29
29
30
30
## Development History
31
31
32
-
The original AIA eventually had modules for some 24 different algorithms, and was used by students at The University of Melbourne and elsewhere. With advances in web technology and changing versions of languages, libraries, and web browsers, the program became progressively slower and slower, and eventually was no longer usable.
32
+
The original AIA eventually had modules for some 24 different algorithms, and was used by students at The University of Melbourne and elsewhere. It won two algorithm animation awards. With advances in web technology and changing versions of languages, libraries, and web browsers, the program became progressively slower and slower, and eventually was no longer usable.
33
33
34
-
Starting in 2020, the program has been redeveloped by successive groups of Software Engineering and Computer Science students at The University of Melbourne, using the latest software tools.
35
-
36
-
XXXLee ? as at <date> AIA has XX number of modules, covering: NAMES OF MODULES
37
-
38
-
XXXLee Something about AIA on github.
34
+
Starting in 2020, the program has been redeveloped by successive groups of Software Engineering, Computer Science and IT students plus interns at The University of Melbourne, using the latest software tools. In the second half (second semester) of 2023 there was a significant change to some of the core modules to keep up with the latest version of Javascript, Python and the packages AIA relies on, plus a revamp of the github repository, including the [WIKI](https://github.com/algorithms-in-action/algorithms-in-action.github.io/wiki). The plan is to ensure the master branch and executable system hosted on github has only stable, high quality algorithm animations visible. The repository will also contain other algorithm animations at various stages of development. The three academics involved in the initial development are now retired but still supervise development; we would welcome contact with others who are interested in using and/or contributing to AIA.
39
35
40
36
The detail version history can be accessed in wiki: [Version History](https://github.com/algorithms-in-action/algorithms-in-action.github.io/wiki/Version-History).
Navigate to the **root directory of the project** and run c to install all the dependencies in package.json
66
+
Navigate to the **root directory of the project** and run npm to install all the dependencies in package.json
71
67
72
68
```bash
73
69
npm install
@@ -83,7 +79,7 @@ npm start
83
79
84
80
### Branch Management
85
81
86
-
Currently, this project use `dev` as main branch. The branch named like `dev-20XXSX` will be development branch for new version. Only the development branch should be merged into main branch.
82
+
Currently, this project use `dev` as main branch. The branch named like `dev-20YYSX` (20YY = year, X = semester number) will be development branch for new version. Only the development branch should be merged into main branch.
87
83
88
84
Therefore, if you are going to develop some new features or fix some bugs for the project, you should create a personal branch to write your code, and then merge your code into target branch.
0 commit comments