Mercurial > public > algo-animator

changeset 45:08ec3e96a02c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change info files
author Dennis <dennis@denniscm.com>
date Fri, 11 Aug 2023 15:27:59 +0000
parents 10af07920b40
children 701dc4e9f2f6
files DOCS.md LICENSE.md LICENSE.txt README.md README.org README.txt
diffstat 6 files changed, 75 insertions(+), 99 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/DOCS.md	Fri Aug 11 15:27:59 2023 +0000
@@ -0,0 +1,54 @@
+
+# Table of Contents
+
+1.  [Compile](#org5155f5d)
+2.  [Run](#org4284749)
+3.  [Notes](#orgfd96d06)
+
+This project is inspired by the video of Timo Bingmann called [15 sorting algorithms in 6 minutes](https://www.youtube.com/watch?v=kPRA0W1kECg).
+
+![img](https://denniscm.com/static/algo-animator-1.png)
+
+![img](https://denniscm.com/static/algo-animator-2.png)
+
+
+<a id="org5155f5d"></a>
+
+# Compile
+
+    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.
+
+
+<a id="org4284749"></a>
+
+# Run
+
+To customize the program you can pass the following arguments.
+
+    ./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
+
+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
+
+![img](https://denniscm.com/static/algo-animator-3.png)
+
+
+<a id="orgfd96d06"></a>
+
+# 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.
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE.md	Fri Aug 11 15:27:59 2023 +0000
@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 2023 Dennis
+
+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 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/LICENSE.txt	Tue Aug 08 19:02:40 2023 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,35 +0,0 @@
-                       ━━━━━━━━━━━━━━━━━━━━━━━━━━
-                                LICENSE
-
-                        Dennis Concepcion Martin
-                       ━━━━━━━━━━━━━━━━━━━━━━━━━━
-
-
-Table of Contents
-─────────────────
-
-
-
-
-MIT License
-
-Copyright (c) 2023 Dennis
-
-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 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.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Fri Aug 11 15:27:59 2023 +0000
@@ -0,0 +1,11 @@
+
+# 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).
+
+-   Docs: <https://denniscm.com/proj/algo-animator.html>
+-   Main repo on SourceHut: <https://git.sr.ht/~denniscmartin/algo-animator>
+    -   Mirrors:
+        -   Github: <https://github.com/denniscmartin/algo-animator>
+        -   Gitlab: <https://gitlab.com/denniscmartin/algo-animator>
+
--- a/README.org	Tue Aug 08 19:02:40 2023 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,42 +0,0 @@
-* README
-:PROPERTIES:
-:EXPORT_FILE_NAME: README.txt
-:END:
-
-** algo-animator
-
-An interactive program to visualize sorting algorithms. Developed in C using OpenGL, GLUT, and FreeType.
-
-- Docs: [[https://denniscm.com/projects/algo-animator]]
-- Main repo on SourceHut: [[https://git.sr.ht/~denniscmartin/algo-animator]]
-  - Mirrors:
-    - Github: [[https://github.com/denniscmartin/algo-animator]]
-    - Gitlab: [[https://gitlab.com/denniscmartin/algo-animator]]
-
-* LICENSE
-:PROPERTIES:
-:EXPORT_FILE_NAME: LICENSE.txt
-:END:
-
-MIT License
-
-Copyright (c) 2023 Dennis
-
-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 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.txt	Tue Aug 08 19:02:40 2023 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,22 +0,0 @@
-                       ━━━━━━━━━━━━━━━━━━━━━━━━━━
-                             ALGO-ANIMATOR
-
-                        Dennis Concepcion Martin
-                       ━━━━━━━━━━━━━━━━━━━━━━━━━━
-
-
-Table of Contents
-─────────────────
-
-
-
-
-An interactive program to visualize sorting algorithms. Developed in C
-using OpenGL, GLUT, and FreeType.
-
-• Docs: <https://denniscm.com/projects/algo-animator>
-• Main repo on SourceHut:
-  <https://git.sr.ht/~denniscmartin/algo-animator>
-  • Mirrors:
-    • Github: <https://github.com/denniscmartin/algo-animator>
-    • Gitlab: <https://gitlab.com/denniscmartin/algo-animator>