annotate DOCS.md @ 45:08ec3e96a02c

Change info files
author Dennis <dennis@denniscm.com>
date Fri, 11 Aug 2023 15:27:59 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
45
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
1
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
2 # Table of Contents
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
3
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
4 1. [Compile](#org5155f5d)
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
5 2. [Run](#org4284749)
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
6 3. [Notes](#orgfd96d06)
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
7
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
8 This project is inspired by the video of Timo Bingmann called [15 sorting algorithms in 6 minutes](https://www.youtube.com/watch?v=kPRA0W1kECg).
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
9
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
10 ![img](https://denniscm.com/static/algo-animator-1.png)
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
11
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
12 ![img](https://denniscm.com/static/algo-animator-2.png)
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
13
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
14
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
15 <a id="org5155f5d"></a>
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
16
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
17 # Compile
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
18
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
19 mkdir build
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
20 cd build
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
21 cmake ..
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
22 make
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
23
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
24 Currently I've only tested this project on Linux. However, I would like to prepare it so that it can be used on Mac and Windows. However, my cross-platform experience is almost non-existent. Maybe in the future I'll check how to do it.
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
25
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
26
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
27 <a id="org4284749"></a>
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
28
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
29 # Run
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
30
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
31 To customize the program you can pass the following arguments.
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
32
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
33 ./algo_animator WINDOW_WIDTH WINDOW_HEIGHT RECTANGLE_WIDTH SPACE_BETWEEN_RECTANGLES
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
34
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
35 The default values are:
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
36
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
37 WINDOW_WIDTH = 1920
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
38 WINDOW_HEIGHT = 1080
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
39 RECTANGLE_WIDTH = 5
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
40 SPACE_BETWEEN_RECTANGLES = 1
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
41
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
42 Run the program in a window with width of 1920 pixels and height of 1080 pixels, fit the screen with rectangles with width of 50 pixels, and add a space between rectangles of 3 pixels.
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
43
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
44 ./algo_animator 1920 1080 50 3
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
45
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
46 ![img](https://denniscm.com/static/algo-animator-3.png)
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
47
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
48
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
49 <a id="orgfd96d06"></a>
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
50
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
51 # Notes
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
52
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
53 This project has not been designed to compare the speed of the algorithms side by side. The main objective is the visualization of the algorithms for educational purposes.
08ec3e96a02c Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
54