diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf0758c --- /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/locimend +``` + +3. Change the working directory to the project: + +```bash +cd locimend +``` + +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.