From d13eeab65c8ed727930cd87002f2719084c87469 Mon Sep 17 00:00:00 2001 From: Don Setiawan Date: Wed, 11 Dec 2024 10:54:12 -0800 Subject: [PATCH] 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 <175728472+Copilot@users.noreply.github.com> * Update phylo2vec/README.md --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- phylo2vec/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 phylo2vec/README.md diff --git a/phylo2vec/README.md b/phylo2vec/README.md new file mode 100644 index 0000000..ca99c14 --- /dev/null +++ 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. +