From 34e2795216d610389e05cba52fcb781ba1b433bc Mon Sep 17 00:00:00 2001 From: Hammad Bashir Date: Fri, 8 Mar 2024 09:10:48 -0800 Subject: [PATCH] [DOC] Update and rename README to README.md (#1848) Doc cleanup --- rust/worker/README | 7 ------- rust/worker/README.md | 12 ++++++++++++ 2 files changed, 12 insertions(+), 7 deletions(-) delete mode 100644 rust/worker/README create mode 100644 rust/worker/README.md diff --git a/rust/worker/README b/rust/worker/README deleted file mode 100644 index e09a7db4f4c..00000000000 --- a/rust/worker/README +++ /dev/null @@ -1,7 +0,0 @@ -# Readme - - - - -### Rust version -Use rust 1.74.0 or greater. diff --git a/rust/worker/README.md b/rust/worker/README.md new file mode 100644 index 00000000000..f209f72eb33 --- /dev/null +++ b/rust/worker/README.md @@ -0,0 +1,12 @@ +# Readme +This folder houses the Rust code for the query and compactor nodes. It is a standard rust crate managed using cargo. + +### Testing +`cargo test` + +### Building +`cargo build` + + +### Rust version +Use rust 1.74.0 or greater.