Mercurial > public > algo-animator

changeset 44:10af07920b40

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
change README to org
author Dennis <dennis@denniscm.com>
date Tue, 08 Aug 2023 19:02:40 +0000
parents a809e4200185
children 08ec3e96a02c
files LICENSE.md LICENSE.txt README.md README.org README.txt
diffstat 5 files changed, 99 insertions(+), 96 deletions(-) [+]
line wrap: on
line diff
--- a/LICENSE.md	Wed Aug 02 16:41:56 2023 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,21 +0,0 @@
-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/LICENSE.txt	Tue Aug 08 19:02:40 2023 +0000
@@ -0,0 +1,35 @@
+                       ━━━━━━━━━━━━━━━━━━━━━━━━━━
+                                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.
--- a/README.md	Wed Aug 02 16:41:56 2023 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,75 +0,0 @@
-# algo-animator
-
-An interactive program to visualize sorting algorithms.  
-I also made a video about this project [Youtube](https://youtu.be/KvOI88s-FsU)
-
-This project is inspired by - off course - the video by Timo Bingmann called 
-[15 sorting algorithms in 6 minutes](https://www.youtube.com/watch?v=kPRA0W1kECg).
-
-![1](https://github.com/denniscmartin/algo-animator/assets/66180929/cf3396f6-2e66-4949-b7bd-2ba0ac4b8529)
-![2](https://github.com/denniscmartin/algo-animator/assets/66180929/14b4fe88-489e-4dcd-af3c-faa1f941ed9b)
-
-## Compile
-
-```bash
-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*
-
-## Run
-
-To customize the program you can pass the following arguments. 
-
-```bash
-./algo_animator WINDOW_WIDTH WINDOW_HEIGHT RECTANGLE_WIDTH SPACE_BETWEEN_RECTANGLES
-```
-
-The default values are:
-
-```bash
-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.
-
-```bash
-./algo_animator 1920 1080 50 3
-```
-
-## Examples
-
-### Normal mode
-
-Just run the program and press `ENTER`  
-[Video.webm](https://github.com/denniscmartin/algo-animator/assets/66180929/f75366b4-b8ba-421e-8c1e-f43727a67b4f)
-
-### Slow motion
-
-Use `u` to increase the delay, then `ENTER` to run the algorithm   
-*The delay is applied after each iteration*  
-[Video.webm](https://github.com/denniscmartin/algo-animator/assets/66180929/b3bcde87-2680-4667-98be-3b3946712254)
-
-### Pause mode
-
-Press `ENTER` then `p`   
-[Video.webm](https://github.com/denniscmartin/algo-animator/assets/66180929/6a3ff80c-56dc-4b1a-a811-e3649fe2edde)
-
-### Sequential mode
-
-Press `q` then press `ENTER` to visualize the algorithm step by step.   
-[Video.webm](https://github.com/denniscmartin/algo-animator/assets/66180929/743c00d8-5236-437d-85ad-b139611175ef)
-
-## 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/README.org	Tue Aug 08 19:02:40 2023 +0000
@@ -0,0 +1,42 @@
+* 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.
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Tue Aug 08 19:02:40 2023 +0000
@@ -0,0 +1,22 @@
+                       ━━━━━━━━━━━━━━━━━━━━━━━━━━
+                             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>