From a7959056c42a0bda9b3da0ac340d2566fc8dfe3b Mon Sep 17 00:00:00 2001
From: Niko <nikolaos.papadopoulos@univie.ac.at>
Date: Tue, 19 Nov 2024 22:12:22 +0100
Subject: [PATCH] main README drafted

---
 README.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 39a79c4..ed38172 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
-# plit-genome
-The scripts and pipelines for the P. litorale draft genome assembly (DOI: xxx)
+# The _Pycnogonum litorale_ (Strøm, 1762) draft genome
+
+This repository contains the computational analysis for the P. litorale draft genome manuscript. The
+code is split up by task, and should roughly correspond to the respective "Materials and Methods"
+sections of the manuscript.
+
+1. **Assembly:** code for read QC and genome assembly.
+2. **Scaffolding:** code for scaffolding with `yahs`.
+3. **Repeats:** repeat prediction and annotation.
+4. **Contam:** analysis of repeats and possible contaminants; contaminant removal.
+5. **Transcriptomes:** de-novo assembly of deeply sequenced developmental transcriptomes.
+6. **Annotation:** prediction of protein-coding genes and tRNAs.
+7. **Analysis:** downstream analysis; placing _P. litorale_ in the chelicerate/arthropod context,
+   finding Hox genes, functional annotation with EggNOG-mapper.
+8. **Submission:** scripts to handle ENA submission.
+
+The project's raw data can be found on ENA under project ID [](). Additional (intermediate) results
+have been uploaded to Zenodo under the DOI [10.5281/zenodo.14185694](10.5281/zenodo.14185694).
\ No newline at end of file
-- 
GitLab