From afceeba1968aba6d19e77a830c34cd396e83701f Mon Sep 17 00:00:00 2001 From: penguin Date: Wed, 21 Oct 2020 18:41:03 -0500 Subject: [PATCH] Updated readme with some basic instructions --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index aac90175..9b37ca1a 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ # ePenguin Software Framework + +### Instructions for testing +``` +cd ~ +# clone esf +git clone git@git.epenguin.net:ePenguin/ePenguin-Software-Framework.git +# clone igloo +git clone git@git.epenguin.net:ePenguin/ePenguin-Igloo.git +# export esf +export ESF_DIR=~/ePenguin-Software-Framework +# alias the igloo cmd +alias igloo=~/ePenguin-igloo/target/release/igloo + +# Now test it: +igloo +``` +You should see a help menu thrown at you.