Store readme from itch.io

2 files changed, 52 insertions, 4 deletions

diff --git a/readme.md b/NOTES.md
index dbbd45f..cca4480 100644
--- a/readme.md
+++ b/NOTES.md
@@ -1,10 +1,12 @@
-Surgery Log
-===========
+notes
+=====
+
+# misc
 
-# Notes
 - Location of `user://`: `~/.local/share/godot/app_userdata/`.
 
-# ToDo
+# todo
+
 - [x] Datepicker: On click (without drag) reset velocity to 0; show and focus 'input' to allow introducing value.
 - [x] Selecting last (year?)/month/day and de-selecting it, moves value to next;
 - [x] Solve how entries are shared across db_screen and stage_screen;
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0e95b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+Surgery Log
+===========
+
+Surgery oriented database insertion tool.
+
+---
+
+This is a very simple tool to help input surgery oriented records on a
+database using the mobile phone.  
+
+# Why use it?
+
+Because! Also, most of the input fields have a drop-down list that helps
+you fill in the data. As new entries get created on the database, the
+field values are used to populate the drop-down option sets to help fill
+in the subsequent records.
+
+To avoid cluttering the drop-down lists, the fields "Type" and
+"Sub-type" are used to filter which options appear on the fields
+"Sub-sub-type", "Pathology", and "Intervention".  
+
+From the main screen, where the database entries are listed, you are
+able to create new entries, edit or delete existing ones.
+
+From the menu (cogwheel) you are able to import, export and clear both
+the option sets present on the drop-down menus and the database entries
+(to CSV and JSON). There's also an option to toggle between the
+day/night visual themes.  
+
+# Why create such tool?
+
+This tool came into existence after being asked to insert several
+hundreds of paper records into a database. As you can imagine, after
+inserting the first dozen I thought what every programmer thinks when
+performing repetitive tasks "let's automate this". Since I could not
+easily automate the task, I decided to avoid it completely by providing
+a convenient tool that allowed people to create the entries via mobile
+phone instead of creating more paper records.
+
+# Why use Godot?
+
+Tired of spending time setting up project dependencies and whatnot (yes
+I'm looking at you Android Studio & Friends), I decided to give Godot a
+go. Oh boy, did I spend time creating UI features... Nevertheless, I
+still don't regret the decision. I'd rather write UI components than
+setup SDKs and stuff.