annotate README.md @ 54:2016dc709c7b default tip

Update typos
author Dennis C. M. <dennis@denniscm.com>
date Mon, 02 Jun 2025 19:20:51 +0100
parents 10a7b0e258f4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
1 # Algo Animator
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
2
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
3 This project is inspired by the video of Timo Bingmann called [15 sorting
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
4 algorithms in 6 minutes](https://www.youtube.com/watch?v=kPRA0W1kECg)
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
5
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
6 ![alt text](.repo/1.png) ![alt text](.repo/2.png)
48
10a7b0e258f4 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 47
diff changeset
7
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
8 ## Usage
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
9
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
10 ### Compile
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
11
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
12 mkdir build cd build cmake .. make
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
13
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
14 Currently I've only tested this project on Linux. However, I would like to
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
15 prepare it so that it can be used on Mac and Windows. However, my
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
16 cross-platform experience is almost non-existent. Maybe in the future I'll
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
17 check how to do it.
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
18
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
19 ### Run
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
20
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
21 To customize the program you can pass the following arguments.
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
22
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
23 ./algo_animator WINDOW_WIDTH WINDOW_HEIGHT RECTANGLE_WIDTH
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
24 SPACE_BETWEEN_RECTANGLES
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
25
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
26 The default values are:
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
27
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
28 WINDOW_WIDTH = 1920 WINDOW_HEIGHT = 1080 RECTANGLE_WIDTH = 5
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
29 SPACE_BETWEEN_RECTANGLES = 1
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
30
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
31 Run the program in a window with width of 1920 pixels and height of 1080
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
32 pixels, fit the screen with rectangles with width of 50 pixels, and add a space
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
33 between rectangles of 3 pixels.
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
34
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
35 ./algo_animator 1920 1080 50 3
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
36
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
37 # Notes
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
38
54
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
39 This project has not been designed to compare the speed of the algorithms side
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
40 by side. The main objective is the visualization of the algorithms for
2016dc709c7b Update typos
Dennis C. M. <dennis@denniscm.com>
parents: 48
diff changeset
41 educational purposes.
47
f60144ebce23 Fix build for mac
Dennis C. M. <dennis@denniscm.com>
parents: 46
diff changeset
42