Mercurial > public > algo-animator

changeset 54:2016dc709c7b default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update typos
author Dennis C. M. <dennis@denniscm.com>
date Mon, 02 Jun 2025 19:20:51 +0100
parents d44c59576969
children
files .github/1.png .github/2.png .gitignore .hgignore .repo/1.png .repo/2.png LICENSE.md README.md
diffstat 8 files changed, 37 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
Binary file .github/1.png has changed
Binary file .github/2.png has changed
--- a/.gitignore	Sat Apr 05 12:33:57 2025 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
-out
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.hgignore	Mon Jun 02 19:20:51 2025 +0100
@@ -0,0 +1,1 @@
+out
\ No newline at end of file
Binary file .repo/1.png has changed
Binary file .repo/2.png has changed
--- a/LICENSE.md	Sat Apr 05 12:33:57 2025 +0100
+++ b/LICENSE.md	Mon Jun 02 19:20:51 2025 +0100
@@ -1,10 +1,22 @@
 MIT License
 
-Copyright (c) 2023 Dennis
+Copyright (c) 2023 Dennis Micro Computers
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
 
--- a/README.md	Sat Apr 05 12:33:57 2025 +0100
+++ b/README.md	Mon Jun 02 19:20:51 2025 +0100
@@ -1,43 +1,42 @@
-
-# algo-animator
-
-An interactive program to visualize sorting algorithms. Developed in C using OpenGL, GLUT and FreeType. I also made a video about this project -> [Youtube](https://youtu.be/KvOI88s-FsU).
+# Algo Animator
 
-This project is inspired by the video of Timo Bingmann called [15 sorting algorithms in 6 minutes](https://www.youtube.com/watch?v=kPRA0W1kECg)
+This project is inspired by the video of Timo Bingmann called [15 sorting
+algorithms in 6 minutes](https://www.youtube.com/watch?v=kPRA0W1kECg)
 
-![alt text](.github/1.png)
-![alt text](.github/2.png)
+![alt text](.repo/1.png) ![alt text](.repo/2.png)
 
 ## Usage
 
 ### Compile
 
-    mkdir build
-    cd build
-    cmake ..
-    make
+	mkdir build cd build cmake ..  make
 
-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.
+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.
 
 ### Run
 
 To customize the program you can pass the following arguments.
 
-    ./algo_animator WINDOW_WIDTH WINDOW_HEIGHT RECTANGLE_WIDTH SPACE_BETWEEN_RECTANGLES
+	./algo_animator WINDOW_WIDTH WINDOW_HEIGHT RECTANGLE_WIDTH
+	SPACE_BETWEEN_RECTANGLES
 
 The default values are:
 
-    WINDOW_WIDTH = 1920
-    WINDOW_HEIGHT = 1080
-    RECTANGLE_WIDTH = 5
-    SPACE_BETWEEN_RECTANGLES = 1
+	WINDOW_WIDTH = 1920 WINDOW_HEIGHT = 1080 RECTANGLE_WIDTH = 5
+	SPACE_BETWEEN_RECTANGLES = 1
 
-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.
+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.
 
-    ./algo_animator 1920 1080 50 3
+	./algo_animator 1920 1080 50 3
 
 # Notes
 
-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.
+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.
 
-