docs: Add a small readme for rust directory (#46)

* docs: Add a small readme for rust directory * Update phylo2vec/README.md Co-authored-by: Copilot <[email protected]> * Update phylo2vec/README.md --------- Co-authored-by: Copilot <[email protected]>
uw-ssec · Dec 11, 2024 · d13eeab · d13eeab
1 parent 0b7a9b8
commit d13eeab
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/phylo2vec/README.md b/phylo2vec/README.md
@@ -0,0 +1,18 @@
+# phylo2vec-rust
+
+This directory contains the core codebase for `phylo2vec` package written in Rust.
+
+If you are not familiar with Rust, there are several subdirectories that are important
+within this directory, as well as a configuration file to be aware of:
+
+```console
+.
+├── Cargo.toml  # This is the Rust Cargo Manifest containing the needed metadata to compile the package
+├── README.md # This README you're reading
+├── benches/ # This subdirectory contains code to perform benchmarking on the Rust package
+└── src/ # This subdirectory is where the source code is located
+```
+
+For more information about the Cargo Manifest, check out the 
+[Official Cargo Documentation](https://doc.rust-lang.org/cargo/reference/manifest.html) on it.
+