about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-11-03 22:59:37 +0530
committerAndinus <andinus@nand.sh>2021-11-03 22:59:37 +0530
commit12cec2e391487286a84990bd5dec37a2273050e5 (patch)
treefc4282bc1ce39e0354cf076d548fb2812c6c49aa
parent3ddfc60b3ba7744760fdea33068ceb3fe687c66c (diff)
downloadfornax-12cec2e391487286a84990bd5dec37a2273050e5.tar.gz
Add News section in README
-rw-r--r--README46
-rw-r--r--README.org31
2 files changed, 48 insertions, 29 deletions
diff --git a/README b/README
index d33b52c..e3be23d 100644
--- a/README
+++ b/README
@@ -12,9 +12,11 @@ Table of Contents
 
 1. Demo
 2. Documentation
-3. Fornax Format
+3. Project Structure
+4. Fornax Format
 .. 1. Grids
-4. Project Structure
+5. News
+.. 1. v0.1.0 - 2021-11-03
 
 
 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
@@ -55,7 +57,24 @@ This collection includes:
     number then the slideshow might be incorrect.
 
 
-3 Fornax Format
+3 Project Structure
+═══════════════════
+
+  • Algorithms are located in `algorithms/' directory, sub-directory
+    needs to be created for programming languages which will hold the
+    actual source.
+
+  • Sample solutions can be found in `resources/solutions/' directory.
+
+    • *Note*: Some solutions might output illegal moves (like walking
+      over blocked path), this error is only in visualization, the
+      solution is correct.
+
+      This has been fixed in commit
+      `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'.
+
+
+4 Fornax Format
 ═══════════════
 
   Fornax format is an intermediate output file generated after solving
@@ -86,7 +105,7 @@ This collection includes:
   • First iteration is assumed to be the maze.
 
 
-3.1 Grids
+4.1 Grids
 ─────────
 
   A grid is printed for every iteration. Grids are composed of cells.
@@ -106,18 +125,11 @@ This collection includes:
     symbol if it makes sense.
 
 
-4 Project Structure
-═══════════════════
-
-  • Algorithms are located in `algorithms/' directory, sub-directory
-    needs to be created for programming languages which will hold the
-    actual source.
-
-  • Sample solutions can be found in `resources/solutions/' directory.
+5 News
+══════
 
-    • *Note*: Some solutions might output illegal moves (like walking
-      over blocked path), this error is only in visualization, the
-      solution is correct.
+5.1 v0.1.0 - 2021-11-03
+───────────────────────
 
-      This has been fixed in commit
-      `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'.
+  ⁃ Initial implementation. Includes DFS solver in Java, tool to
+    visualize the solution.
diff --git a/README.org b/README.org
index 7432478..98a58b7 100644
--- a/README.org
+++ b/README.org
@@ -29,6 +29,21 @@ later converted to a slideshow with ~ffmpeg~.
 - *Note*: If the number of iterations are greater than an 8 digit number
   then the slideshow might be incorrect.
 
+* Project Structure
+
+- Algorithms are located in ~algorithms/~ directory, sub-directory needs
+  to be created for programming languages which will hold the actual
+  source.
+
+- Sample solutions can be found in ~resources/solutions/~ directory.
+
+  - *Note*: Some solutions might output illegal moves (like walking over
+    blocked path), this error is only in visualization, the solution is
+    correct.
+
+    This has been fixed in commit
+    ~8cef86f0eb8b46b0ed2d7c37fa216890300249f6~.
+
 * Fornax Format
 
 Fornax format is an intermediate output file generated after solving the
@@ -73,17 +88,9 @@ A grid is printed for every iteration. Grids are composed of cells.
 - /Current Position/ is prioritized over /Blocked/ & /Destination/ symbol if
   it makes sense.
 
-* Project Structure
+* News
 
-- Algorithms are located in ~algorithms/~ directory, sub-directory needs
-  to be created for programming languages which will hold the actual
-  source.
-
-- Sample solutions can be found in ~resources/solutions/~ directory.
+** v0.1.0 - 2021-11-03
 
-  - *Note*: Some solutions might output illegal moves (like walking over
-    blocked path), this error is only in visualization, the solution is
-    correct.
-
-    This has been fixed in commit
-    ~8cef86f0eb8b46b0ed2d7c37fa216890300249f6~.
++ Initial implementation. Includes DFS solver in Java, tool to visualize
+  the solution.