add README and adjust index

mmiots9 · Dec 5, 2022 · dc3c69f · dc3c69f
1 parent c91fc11
commit dc3c69f
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+<h1 align="center">English verbs app 🇬🇧🇮🇹</h1>
+
+This repository contains a Flask app for the study of English irregular verbs.
+<br>
+<h3 style="margin-bottom:3px;">Features</h3>
+<ul>
+  <li>Study irregular verbs (~200 verbs)</li>
+  <li>Italian translation</li>
+  <li>Test your knowledge of irregular verbs</li>
+</ul>
+
+<h3>Installation</h3>
+<p style="margin-bottom:3px;">To install the app, clone this repositories and create a conda env with these packages:</p>
+<ul>
+  <li>python >3.7</li>
+  <li>Flask >2.0.0</li>
+  <li>pandas >1.5.0</li>
+</ul>
+
+<h3>Launch app</h3>
+To launch the app, use the command:
+
+```
+python3 <path_to_folder>/app.py
+```
+
+The app is active and the running path will be printed on the terminal. Copy the path to a browser and start using the app.
+
+<h3>Study</h3>
+On the main page, select "study" to see the list of all irregular verbs (present simple, past simple, past participle) and their Italian translation.
+
+<h3>Test</h3>
+On the main page, select "test" and start a 10-verbs test. For each verb, one of the 4 declination is given, you have to insert the other 3. 
+<br>
+Once finished, a page with all the verbs will open, with correct verbs highlighted in green and the wrong ones in red with the correction.
diff --git a/app.py b/app.py
@@ -82,4 +82,4 @@ def show_results():
 
     # RUN APP
 if __name__ == "__main__":
-    app.run(debug=True)
+    app.run(debug=False)
diff --git a/templates/index.html b/templates/index.html
@@ -9,7 +9,7 @@
     <link rel="stylesheet" href="static/css/index.css">
 </head>
 <body>
-    <h1>Welcome Adriana!</h1>
+    <h1>Welcome!</h1>
     <h2>Here you can study and test your knowledge on "irregular verbs"</h2>
     <h2>Press "STUDY" to show the irregular verbs or "TEST" to start a test</h2>
     <div id="form-container">