Merge pull request #1 from EnzoAlbornoz/master

v0.1.4
EnzoAlbornoz · Feb 24, 2021 · 6dccf09 · 6dccf09
2 parents 0d2773f + e6cdf94
commit 6dccf09
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/printFLWarrior.png b/printFLWarrior.png
diff --git a/readme.md b/readme.md
@@ -0,0 +1,20 @@
+
+# FLWarrior <img src="./src/assets/knight.svg" width="324" height="324">
+#### Formal Languages Class Project
+
+This project has is divided between **back-end** and **front-end**.
+
+The back-end is under the `lib/` folder and is used by the front-end to implement the logic of Grammars, RegularExpressions, and Machines. Each of these, in the front-end, have their own `index.tsx` and edit `pages.tsx`. The front-end is located in the `pages/` folder.
+
+We also use the browser-integrated database to store information about the languages, which makes this project esclusively client-sided. This is located in the `database/` folder.
+
+## Running
+
+You will need NodeJS v14.x or higher
+```
+npm install # Installs dependences
+npm run start # runs
+```
+
+### Interface capture:
+<img src="./printFLWarrior.png" width="824" height="524">