From 47804c8b434c0c6aa16bd3dd93cb394e3eb39965 Mon Sep 17 00:00:00 2001 From: Spencer Kohan Date: Mon, 13 Apr 2020 12:32:40 +0200 Subject: [PATCH] added installation instructions --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 521c751..d26b4ed 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,16 @@ This tool should be easy to understand for those who are already familiar with ` ## Installation -The easiest way to install +The easiest way to install dirsync is with cargo install: -**Note: this crate relies on openssl to be installed on the system. Instructions can be found [here](https://docs.rs/openssl/0.10.29/openssl/) +``` +// clone the repo: +$ git clone https://github.com/spencerkohan/dirsync && cd dirsync +// install +$ cargo install --path . +``` + +***Note:*** this crate relies on openssl to be installed on the system. Instructions can be found [here](https://docs.rs/openssl/0.10.29/openssl/) ## Usage