From 5be45d403a66491ce765b7030cf1defb132d4dc6 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sat, 5 Sep 2020 13:15:34 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=9B=A0=20Build=20Docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 71cc045d..7ea5fd80 100644 --- a/README.md +++ b/README.md @@ -238,6 +238,39 @@ sudo dnf install libx11-devel libxcursor-devel libpng-devel - [clickgen](https://pypi.org/project/clickgen/) +## Build From Scratch + +### ⚡ Auto Build (using GitHub Actions) + +GitHub Actions is automatically runs on every `push`(on **master** and **dev** branches) and `pull request`(on **master** branch), You found theme resources in `artifact` section of **build**.GitHub **Actions** available inside [.github/workflows](https://github.com/ful1e5/Bibata_Cursor/tree/master/.github/workflows) directory. + +### Manual Build + +#### Setup python environment + +```bash +python3 -m pip install --upgrade pip # Update pip to latest +python3 -m pip3 install virtualenv # Install python virtual environment +virtualenv venv # Create new virtualenv named `venv` +source venv/bin/activate # Activate virtualenv + +# For Deactivate virtualenv +deactivate +``` + +#### Compile From Source + +> Make sure your [python environment](#setup-python-environment) setup and `virtualenv` is **active**. + +##### Using yarn + +```bash +yarn install # Install all Node Packages +yarn py_install # Install all PyPi Packages +yarn render # Render all Bibata Bitmaps +yarn build # Build Bibata_Cursor package +``` + ## You may also like...