Improve docs

README.md

@@ -6,7 +6,7 @@
 
 DnaDesign is a Go project creating tools for automated genetic design, spanning from the lowest levels of DNA sequence manipulation to higher level functionality.
 
-* **Practical:** DnaDesign tooling is meant to be used by practitioners of synthetic biology. Let's make something actually useful!
+* **Practical:** DnaDesign tooling is meant to be used by practitioners of synthetic biology.
 
 * **Modern:** DnaDesign is at the bleeding edge of technology. We are happy to adopt the newest advancements in synthetic biology, wasm, LLMs, and more to get our tools in the hands of people who need it.
 
@@ -16,6 +16,34 @@ DnaDesign is a Go project creating tools for automated genetic design, spanning
 
 * **[Library](https://pkg.go.dev/github.com/koeng101/dnadesign)**
 
+## Repo organization
+
+On the highest level:
+* `lib` contains core functionality as a go library.
+* `external` contains functions to work with external bioinformatics command-line interfaces.
+* `api` contains an OpenAPI exposing all the major functions of lib.
+* `deployment` contains full integration tests and yaml for deploying the DnaDesign API to a k3s cluster.
+
+### Detailed repo organization
+
+* [lib](https://pkg.go.dev/github.com/koeng101/dnadesign/lib) contains the core DnaDesign library, with nearly all functionality, all in idiomatic Go with nearly no dependencies.
+    * [lib/bio](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/bio) contains biological parsers for file formats including [genbank](https://github.com/Koeng101/dnadesign/blob/main/lib/bio/genbank/genbank.go), [fasta](https://github.com/Koeng101/dnadesign/blob/main/lib/bio/fasta/fasta.go), [uniprot](https://github.com/Koeng101/dnadesign/blob/main/lib/bio/uniprot/uniprot.go), [fastq](https://github.com/Koeng101/dnadesign/blob/main/lib/bio/fastq/fastq.go), [slow5](https://github.com/Koeng101/dnadesign/blob/main/lib/bio/slow5/slow5.go), [sam](https://github.com/Koeng101/dnadesign/blob/main/lib/bio/sam/sam.go), and [pileup](https://github.com/Koeng101/dnadesign/blob/main/lib/bio/pileup/pileup.go) files.
+    * [lib/align](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/align) contains [Needleman-Wunsch](https://en.wikipedia.org/wiki/Needleman%E2%80%93Wunsch_algorithm) and [Smith-Waterman](https://en.wikipedia.org/wiki/Smith%E2%80%93Waterman_algorithm) alignment functions, as well as the [mash](https://doi.org/10.1186/s13059-016-0997-x) similarity algorithm.
+    * [lib/clone](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/clone) contains functions for simulating [DNA cloning](https://en.wikipedia.org/wiki/Molecular_cloning), including [restriction digestion](https://www.neb.com/en-us/applications/cloning-and-synthetic-biology/dna-preparation/restriction-enzyme-digestion), [ligation](https://en.wikipedia.org/wiki/Ligation_(molecular_biology)), and [GoldenGate assembly](https://en.wikipedia.org/wiki/Golden_Gate_Cloning).
+    * [lib/fold](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/fold) contains DNA and RNA folding simulation software, including the [Zuker](https://doi.org/10.1093/nar/9.1.133) and [LinearFold](https://doi.org/10.1093/bioinformatics/btz375) folding algorithms.
+    * [lib/primers](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/primers) contains [DNA primer](https://www.nature.com/scitable/definition/primer-305/) design functions.
+        * [lib/primers/pcr](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/primers/pcr) contains [PCR](https://www.ncbi.nlm.nih.gov/probe/docs/techpcr/) simulation functions.
+    * [lib/seqhash](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/seqhash) contains the Seqhash algorithm to create universal identifiers for DNA/RNA/protein.
+    * [lib/synthesis](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/synthesis) contains various functions for designing synthetic DNA.
+        * [lib/synthesis/codon](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/synthesis/codon) contains functions for working with [codon tables](https://en.wikipedia.org/wiki/DNA_and_RNA_codon_tables), [translating genes](https://en.wikipedia.org/wiki/Translation_(biology)), and [optimizing codons](https://doi.org/10.1073/pnas.0909910107) for expression.
+        * [lib/synthesis/fragment](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/synthesis/fragment) contains functions for [optimal GoldenGate fragmentation](https://doi.org/10.1371/journal.pone.0238592).
+        * [lib/synthesis/fix](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/synthesis/fix) contains functions for fixing proteins in preparation for synthesis.
+    * [lib/transform](https://pkg.go.dev/github.com/koeng101/dnadesign/lib/transform) contains basic utility functions for transforming DNA, like reverse complementation.
+* [external](https://pkg.go.dev/github.com/koeng101/dnadesign/external) contains integrations with external bioinformatics software, usually operating on the command line.
+    * [external/minimap2](https://pkg.go.dev/github.com/koeng101/dnadesign/external/minimap2) contains a function for working with [minimap2](https://github.com/lh3/minimap2) with Go.
+    * [external/samtools](https://pkg.go.dev/github.com/koeng101/dnadesign/external/samtools) contains a function for generating pileup files using [samtools](https://github.com/samtools/samtools) with Go.
+
+
 ## Contributing
 
 Write good, useful code. Open a pull request, and we'll see if it fits!
@@ -24,13 +52,38 @@ Write good, useful code. Open a pull request, and we'll see if it fits!
 
 * [MIT](LICENSE)
 
-### Sources
+## Sources
 
 There are a few pieces of "complete" software that we have directly integrated into the source tree (with their associated licenses). These projects don't receive updates anymore (or just bug fixes with years between). In particular, `lib` has most of these, since we intend to have as few dependencies as possible in `lib`. The integrated projects include the following.
 - [svb](https://github.com/rleiwang/svb) in `lib/bio/slow5/svb`
 - [intel-cpuid](https://github.com/aregm/cpuid) in `lib/bio/slow5/svb/intel-cpuid`
 - [wordwrap](https://github.com/mitchellh/go-wordwrap) in `lib/bio/genbank`
 
-### Other
+## Other
 
 DnaDesign is a fork of [Poly](https://github.com/TimothyStiles/poly) at commit f76bf05 with a different mission focus. 
+
+# Changelog
+
+All notable changes to this project will be documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+- Added minimap2 and samtools(pileup) integrations in external [#46](https://github.com/Koeng101/dnadesign/pull/46)
+- Added sam parser [#5](https://github.com/Koeng101/dnadesign/pull/5)
+- Added the LinearFold folding algorithms [#38](https://github.com/Koeng101/dnadesign/pull/38)
+- Added Get function to uniprot for getting a single uniprot xml from online [#37](https://github.com/Koeng101/dnadesign/pull/37)
+- Removed murmur3 in favor of crc32 for mash [#33](https://github.com/Koeng101/dnadesign/pull/33)
+- Patch start codon problems [#32](https://github.com/Koeng101/dnadesign/pull/32)
+- Added tests for OpenBSD [#31](https://github.com/Koeng101/dnadesign/pull/31)
+- Removed a large number of unneeded dependencies [#28](https://github.com/Koeng101/dnadesign/pull/28)
+- Added full rebase text database into tree [27b41fb](https://github.com/Koeng101/dnadesign/commit/27b41fb4fdb849d569278c965849e6f28fb2a7f6)
+- Updated uniprot to be a standardized parser [#22](https://github.com/Koeng101/dnadesign/pull/22)
+- Purged unsupported gff parser [#23](https://github.com/Koeng101/dnadesign/pull/23)
+- Moved library to lib directory [#21](https://github.com/Koeng101/dnadesign/pull/21)
+- Fixed issue with JSON codon tables [#4](https://github.com/Koeng101/dnadesign/pull/4)
+- Added Seqhash v2 [#3](https://github.com/Koeng101/dnadesign/pull/3)
+- Added lowercase methylation options during cloning [#2](https://github.com/Koeng101/dnadesign/pull/2)
+- Standardized parsers with generics [#1](https://github.com/Koeng101/dnadesign/pull/1)

lib/mash/example_test.go → lib/align/mash/example_test.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"hash/crc32"
 
-	"github.com/koeng101/dnadesign/lib/mash"
+	"github.com/koeng101/dnadesign/lib/align/mash"
 )
 
 func ExampleMash() {

lib/mash/mash_test.go → lib/align/mash/mash_test.go

@@ -4,7 +4,7 @@ import (
 	"hash/crc32"
 	"testing"
 
-	"github.com/koeng101/dnadesign/lib/mash"
+	"github.com/koeng101/dnadesign/lib/align/mash"
 )
 
 func TestMash(t *testing.T) {