From a0ce85eade874c679a1d49c80f78139f4a14e711 Mon Sep 17 00:00:00 2001
From: pgagnidze <pgagnidze@pm.me>
Date: Tue, 13 Jun 2023 15:16:51 +0400
Subject: [PATCH] fix: markdown formatting

---
 NOTES.md  | 21 ++++++++++++++-------
 README.md |  7 ++++++-
 2 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/NOTES.md b/NOTES.md
index c19cea3..6e837f9 100644
--- a/NOTES.md
+++ b/NOTES.md
@@ -1,20 +1,22 @@
-![test status](https://github.com/pgagnidze/ena/workflows/test/badge.svg)
-
 # Final Project Report: Ena
 
+![test status](https://github.com/pgagnidze/ena/workflows/test/badge.svg)
+
 <p align="center">
   <img src="./example/example.png" alt="Example Ena Image" width="60%"">
 </p>
 
 This language aims to make programming more accessible for Georgians by allowing them to write code in their native language.
 Ena uses the syntax of popular, widely-used languages, modified to use the Georgian alphabet and keywords.
-                                                                       
+
 ### Installation
+
 1. Install [Lua](https://www.lua.org/start.html#installing) and [LuaRocks](https://github.com/luarocks/luarocks/wiki/Download)
 2. Install Ena with LuaRocks - `$ luarocks install ena`
 3. (optional) Install VS Code [Extension](https://marketplace.visualstudio.com/items?itemName=pgagnidze.ena) for syntax highlighting
 
 ### Usage
+
 We can run Ena with:
 
 `$ ena -i [filename] [options]`
@@ -36,7 +38,7 @@ options are:
 For example:
 `$ ena --result --transpile -i example/example.ena`
 
-```
+```text
 Result:
 720
 
@@ -72,7 +74,7 @@ I allowed the use of English keywords and syntax to simplify the evaluation proc
       <code>
 function factorial(n = 6) {
     if n != 0 {
-        return n * factorial(n - 1)
+        return n *factorial(n - 1)
     } else {
         return 1
     }
@@ -88,7 +90,7 @@ function main() {
   <code>
 ფუნქცია ფაქტორიალი(ნ = 6) {
     თუ ნ != 0 {
-        დააბრუნე ნ * ფაქტორიალი(ნ - 1)
+დააბრუნე ნ* ფაქტორიალი(ნ - 1)
     } თუარა {
         დააბრუნე 1
     }
@@ -107,10 +109,11 @@ You can check the [tests](./ena/spec/e2e.lua) for more examples. You can run all
 Execute the [input.ena](./example/input.ena) for the input program. `input.ena` has comments to explain the syntax briefly.
 
 Check out the new [sysinfo.ena](./example/sysinfo.ena) program that shows various system informations for Linux and Darwin os.
-                                                                       
+
 Check out the [Wiki](https://github.com/pgagnidze/ena/wiki) for more details about the Ena syntax.
 
 **Summary of modifications:**
+
 - Optional statement separator (;)
 - Scan the entire AST and collect function names (instead of forward declarations)
 - false, nil and 0 are falsy values
@@ -125,12 +128,14 @@ This enables users to visualize how the Ena code would appear in widely recogniz
 Additionally, the Lua code can be further transpiled into languages such as Python, Typescript, and more.
 
 In addition to the transpiler capability, I have introduced several new features to the system:
+
 - Booleans,
 - Abscence of value (nil)
 - String literals (with concatenation, use `+` sign)
 - Shell execution (with `$` operator)
 
 ## Future
+>
 > What would be needed to get this project ready for production?
 
 To prepare this project for production, I would add modules, for loops, and dictionaries.
@@ -146,6 +151,7 @@ Simultaneously, I would ensure that the language remains approachable for learni
 Check out the [Issues](https://github.com/pgagnidze/ena/issues) for more details about the Ena roadmap.
 
 ## Self assessment
+
 | Criteria | Score |
 | -------- | -------- |
 | Language Completeness  | 2  |
@@ -153,6 +159,7 @@ Check out the [Issues](https://github.com/pgagnidze/ena/issues) for more details
 | Originality & Scope| 2  |
 
 > Have you gone beyond the base requirements? How so?
+
 - Made the project available on Luarocks, a package manager for Lua, which simplifies the installation process for users.
 - Added the CI/CD for the tests to ensure stability and quality.
 - Developed a CLI (Command-Line Interface) tool that offers convenient options for users to interact with the project.
diff --git a/README.md b/README.md
index e33b0c5..595e4d7 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
+# ენა - Ena
+
 ![test status](https://github.com/pgagnidze/ena/workflows/test/badge.svg)
 
-# ენა - Ena
 <p align="center">
   <img src="./example/example.png" alt="Example Ena Image" width="60%"">
 </p>
@@ -10,12 +11,16 @@
 ენა მიზნად ისახავს, ქართველებისთვის ხელმისაწვდომი გახადოს პროგრამირება, რაც გულისხმობს მშობლიურ ენაზე კოდის წერას. ენა იყენებს პოპულარული, ფართოდ გავრცელებული ენების სინტაქსს, რაც დაგვეხმარება მარტივად შევისწავლოთ პროგრამული ენის მახასიათებლები.
 
 ***დეტალურ დოკუმენტაციას შეგიძლიათ გაეცნოთ ენას [ვიკიზე](https://github.com/pgagnidze/ena/wiki)***
+
 ## კონტრიბუცია
+
 თუ იპოვით შეცდომას, გსურთ შემოგთავაზოთ ახალი ფუნქცია ან გჭირდებათ დახმარება რაიმესთან დაკავშირებით, გთხოვთ გახსნათ ახალი მოთხოვნა GitHub Issue-ებში.
 
 ## ლიცენზია
+
 ენა ლიცენზირებულია GPL-3.0 ლიცენზიით. დამატებითი ინფორმაცია იხილეთ [LICENSE](https://github.com/pgagnidze/ena/blob/main/LICENSE) ფაილში.
 
 ## ♥
+
 - Roberto Ierusalimschy-ის პროგრამირების ენის შემსწავლელი კურსის საბოლოო პროექტი ([Report](./NOTES.md))
 - Mark W. Gabby-Li-ის [Mab](https://github.com/mwgabby-li/Mab) პროგრამირების ენაზე დაფუძნებული