Writing the README.md file

README.md

@@ -1,2 +1,27 @@
 # archiver
-A Python script to write down daily notes in an organized fashion.
+A Python3 script to write down daily notes in an organized manner.
+
+## Introduction
+This python3 script was born from a friend's need to have an app that takes in your daily notes directly from a terminal and organize it for you. We had different ideas on how to solve this problem, and this python script is my solution.
+
+When invoking the *archiver*, it will automatically open your preferred editor (nano, vim, or whatever else) and save your input into an organized *.tex* file, in a folder of your preference. Then, if you want, the script will generate a compilable *.tex* file with all your daily entries in the folder and compile it with *pdflatex*.
+
+The folder to store the entries, to store the *.tex* and *.pdf* files, as well as author's name and preferred editor, are store in the *archiver.config* file, which is generated automatically for you when using the script for the first time. The final *.tex* file is generated based on the *preamble.tex* file, which you can customize as you want.
+
+## archiver.config
+The *archiver.config* should look like this
+
+Directory to store entries: /home/<user>/<save_directory>
+Directory to tex file: /home/<user>/<tex_directory>
+Author's name: <author>
+Title: <title>
+Preferred editor: nano
+
+The script will look for the *archiver.config* file in the directory it is stored. If the *config* file is not present, the script will open nano and allow you to fill in the required fields.
+
+## Pre-requisites
+The python3 script is based mainly on built-in libraries, but it requires the installation of the *glob* library. The way I like to install python3 packages is via *pip*
+
+pip3 install -U glob
+
+It also requires a bunch of LaTeX packages, which are probably installed by the distribution you already have. Otherwise, you can install tex-live's full scheme, which is always what I do.