adding docs

Author: LCrossman

docs/assets/BIO W.png

@@ -0,0 +1,98 @@
+**File types and Parsing behaviour**
+
+**Genbank (.gbk) & Embl (.embl)**
+
+
+- We also provide the ability to convert these formats to gff3
+
+Each genome file is a basic text file following a specific ruleset and genbank (gbk) and embl are similar but differ in the required formatting.
+
+
+*Structure and Parsing*
+
+Top Level is the Records type. There is one Records type per genome file.
+Three types of macro have getters and setters for the data, these are SourceAttributes, FeatureAttributes, SequenceAttributes.
+
+The next level is the Record type. There may be one or many Record in a Records (up to ~ 2000 but more usually ~ 50). Each Record has a DNA sequence which is calculated on the fly by slicing the total sequence of Records with the start and stop coordinates. Each Record also has a SourceAttributes macro which stores ID, total start and stop of the Record sequence (different to the CDS features start and stop below). It also stores the Organism among some other database comments.
+
+![explanatory diagram for the file datatypes](assets/records_diagram.png){ loading=lazy }
+
+The full structure of the SourceAttributes, FeatureAttributes and SequenceAttributes is:
+
+![explanatory diagram for the Attribute macros](assets/attributes_diagram.png){ width=500 }
+
+SourceAttributes stores the following in an enum:
+
+```
+pub enum SourceAttributes {
+    Start { value: RangeValue },
+    Stop { value: RangeValue },
+    Organism { value: String },
+    MolType { value: String},
+    Strain { value: String},
+    CultureCollection { value: String},
+    TypeMaterial { value: String},
+    DbXref { value:String}
+}
+```
+
+Where RangeValue can be either of:
+
+```
+RangeValue::Exact(value)
+RangeValue::LessThan(value) 
+RangeValue::GreaterThan(value)
+```
+
+Most RangeValues are Exact(value) with exceptions usually at the start and end of sequences, indicating that they are truncated.
+
+Note that the start and stop of SourceAttributes relate to the sequence of the whole record
+
+Each Record can have None or many hundreds of coding sequences, CDS (stored in the FeatureAttributes).
+These are the predicted genes and contain annotation data per gene such as locus_tag (id), gene (may be empty), start, stop, strand (-1 or +1), codon start (1,2 or 3), product.
+
+FeatureAttributes stores the following in an enum:
+
+```
+pub enum FeatureAttributes {
+    Start { value: RangeValue },
+    Stop { value: RangeValue },
+    Gene { value: String },
+    Product { value: String },
+    CodonStart { value: u8 },
+    Strand { value: i8 },
+ //   ec_number { value: String }
+}
+```
+
+currently EC_number is commented out but could be added back if there is demand
+
+Each CDS also has a DNA sequence .ffn (calculated on the fly from the start, stop and strand) and a protein sequence .faa (translated on the fly from the start, stop, strand and codon_start). The sequences are stored in the SequenceAttributes.
+
+SequenceAttributes stores the following in an enum:
+
+```
+pub enum SequenceAttributes {
+    Start { value: RangeValue },
+    Stop { value: RangeValue },
+    SequenceFfn { value: String },
+    SequenceFaa { value: String },
+    CodonStart { value: u8 },
+    Strand { value: i8 },
+}
+```
+
+Note the start, stop, strand and codon start of SequenceAttributes and FeatureAttributes are identical
+
+Sequences are stored separately in SequenceAttributes for efficiency. Although start, stop, locus_tag, and strand are duplicated in SequenceAttributes and FeatureAttributes, keeping them together may make it easier to slice the sequence and access the specific feature metadata at the same time.
+
+
+
+
+
+
+
+
+
+
+

docs/assets/MICROBIO B.svg

@@ -0,0 +1,39 @@
+# Welcome to micro**BioRust**
+
+A blazing-fast, sustainable bioinformatics toolkit written in [Rust](https://www.rust-lang.org/) — for microbial genomics rresearch, and optimised for functions used in data exploration.  
+
+---
+
+## Features
+
+- 🦀 Built in Rust programming language for speed and safety
+- 🔄 Python bindings _via_ pyo3 for InterOp - Rust meets Python
+- 📦 Open source and community-driven
+
+---
+
+## Get Started!!
+See Installation for details on how to install Rust for Linux, MacOSX and Windows
+Interested in microbiorust-py?  Check out the microbiorust-py section for quick-start & more! 
+
+Start a new project
+```cargo new microBioRust_test```
+
+Add to your Cargo.toml
+```cargo add -p microBioRust```
+
+to add the whole workspace including file parsing, sequence metrics, coming soon data viz (heatmap demonstration) and python bindings (microbiorust-py)
+
+```cargo add -p seqmetrics```  
+```cargo add -p heatmap```  
+```cargo add -p microbiorust-py```
+
+or clone the repo  
+```git clone https://github.com/LCrossman/microBioRust.git```
+
+Build the project  
+```cargo build```
+
+Run the tests  
+```cargo test```
+