From af079f79070c64a75f32683ff27919a2140ec70f Mon Sep 17 00:00:00 2001
From: coolneng <akasroua@gmail.com>
Date: Mon, 15 Jun 2020 19:51:09 +0200
Subject: [PATCH] Replace README.org with README.md

---
 README.md  | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.org | 64 -------------------------------------------
 2 files changed, 80 insertions(+), 64 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.org

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de8333e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+graphPaname
+===========
+
+graphPaname is a system that collects real-time data, relevant to the
+COVID-19 pandemic de-escalation, from the city of Paris.
+
+It works with 4 datasets about the de-escalation:
+
+-   Retailers with home delivery
+-   Additional parking places in relay parkings (parkings connected to
+    public transportation)
+-   Temporary cycling paths
+-   Temporary pedestrian streets
+
+For each dataset, we offer a table with the data, and a map of Paris
+with markers. Additionally, there\'s a section with photos related to
+the COVID-19 pandemic.
+
+Technologies
+------------
+
+-   Flask
+-   Pandas
+-   Folium
+
+Data sources
+------------
+
+-   [Open Data](https://opendata.paris.fr/pages/home/)
+-   [OpenStreetMap](https://www.openstreetmap.org/)
+-   [Flickr](https://flickr.com)
+
+Requirements
+------------
+
+-   Nix
+
+Installation
+------------
+
+1.  Install Nix (compatible with Nix and Linux):
+
+``` {.shell}
+curl -L https://nixos.org/nix/install | sh
+```
+
+There are alternative installation methods, if you don\'t want to pipe
+curl to sh
+
+2.  Clone the repository:
+
+``` {.shell}
+git clone https://coolneng.duckdns.org/gitea/coolneng/graphPaname
+```
+
+3.  Change the working directory to the project:
+
+``` {.shell}
+cd graphPaname
+```
+
+4.  Enter the nix-shell:
+
+``` {.shell}
+nix-shell
+```
+
+5.  Run the tests:
+
+``` {.shell}
+pytest
+```
+
+6.  Execute the Flask application:
+
+``` {.shell}
+flask run
+```
+
+The website can be accessed via **localhost:5000**
diff --git a/README.org b/README.org
deleted file mode 100644
index d83925b..0000000
--- a/README.org
+++ /dev/null
@@ -1,64 +0,0 @@
-* graphPaname
-
-graphPaname is a system that collects real-time data, relevant to the COVID-19 pandemic de-escalation,  from the city of Paris.
-
-It works with 4 datasets about the de-escalation:
-
-- Retailers with home delivery
-- Additional parking places in relay parkings (parkings connected to public transportation)
-- Temporary cycling paths
-- Temporary pedestrian streets
-
-For each dataset, we offer a table with the data, and a map of Paris with markers. Additionally, there's a section with photos related to the COVID-19 pandemic.
-
-** Technologies
-
-- Flask
-- Pandas
-- Folium
- 
-** Data sources
-
-- [[https://opendata.paris.fr/pages/home/][Open Data]]
-- [[https://www.openstreetmap.org/][OpenStreetMap]]
-- [[https://flickr.com][Flickr]]
-
-** Requirements
-
-- Nix
- 
-** Installation
-
-1. Install Nix (compatible with Nix and Linux):
-
-#+BEGIN_SRC shell
-curl -L https://nixos.org/nix/install | sh
-#+END_SRC
-
-There are alternative installation methods, if you don't want to pipe curl to sh
-
-2. Clone the repository:
-
-#+BEGIN_SRC shell
-git clone https://coolneng.duckdns.org/gitea/coolneng/graphPaname
-#+END_SRC
-
-2. Change the working directory to the project:
-
-#+BEGIN_SRC shell
-cd graphPaname
-#+END_SRC
-
-3. Enter the nix-shell:
-
-#+BEGIN_SRC shell
-nix-shell
-#+END_SRC
-
-4. Run flask:
-
-#+BEGIN_SRC shell
-flask run
-#+END_SRC
-
-The website can be accessed via *localhost:5000*