From f3525df1ca080bf02ed6431a02e329a52215436f Mon Sep 17 00:00:00 2001 From: Daniel Centore Date: Thu, 23 May 2024 10:47:33 -0700 Subject: [PATCH] Update readme --- .github/FUNDING.yml | 6 +++--- README.md | 18 ++++++++++++++++++ 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 5b774d1..a2b3b66 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,5 +1,5 @@ # These are supported funding model platforms -github: [electron-react-boilerplate, amilajack] -patreon: amilajack -open_collective: electron-react-boilerplate-594 +# github: [electron-react-boilerplate, amilajack] +# patreon: amilajack +# open_collective: electron-react-boilerplate-594 diff --git a/README.md b/README.md index eed218c..1a2efe2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # Derevo Derevo is a Git GUI for working with Stacked Pull Requests + +# Usage + +``` +git clone https://github.com/daniel-centore/Derevo.git +cd Derevo +npm install + +# If the above line gives a "ModuleNotFoundError: No module named 'distutils'" +# error, run one of the following to install setuptools: +# > brew install python-setuptools +# > pip install setuptools +# > pip3 install setuptools + +npm run start +``` + +Strongly recommended you pull periodically as this is still very under development!