From 34d86fa67c0efa28773dbb208f52eb281e64e651 Mon Sep 17 00:00:00 2001
From: coolneng <akasroua@gmail.com>
Date: Thu, 3 Jun 2021 18:56:18 +0200
Subject: [PATCH] Update README

---
 README.md  | 41 +++++++++++++++++++++++++++++++++++++++++
 README.org |  3 ---
 2 files changed, 41 insertions(+), 3 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..a41715d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# locimend
+
+locimend is a tool that corrects DNA sequencing errors using Deep Learning.
+
+## Technologies
+
+- Tensorflow
+- Biopython
+
+## Installation
+
+This project uses [Nix](https://nixos.org/) to ensure reproducible
+builds.
+
+1.  Install Nix (compatible with MacOS, Linux and
+    [WSL](https://docs.microsoft.com/en-us/windows/wsl/about)):
+
+```bash
+curl -L https://nixos.org/nix/install | sh
+```
+
+2.  Clone the repository:
+
+```bash
+git clone https://git.coolneng.duckdns.org/coolneng/locigenesis
+```
+
+3.  Change the working directory to the project:
+
+```bash
+cd locigenesis
+```
+
+4.  Enter the nix-shell:
+
+```bash
+nix-shell
+```
+
+After running these commands, you will find yourself in a shell that
+contains all the needed dependencies.
diff --git a/README.org b/README.org
deleted file mode 100644
index 39ea2be..0000000
--- a/README.org
+++ /dev/null
@@ -1,3 +0,0 @@
-* locimend
-
-locimend is a tool that corrects DNA sequencing errors.