From c64faa8c36e61c47ae376b1974a92c64426ed132 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+KaizIqbal@users.noreply.github.com> Date: Fri, 7 Aug 2020 18:11:30 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Build=20Docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index e7f01ef..794d343 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,8 @@ Enjoy upcoming **[macOS BigSur](https://www.apple.com/macos/big-sur-preview/)** - python (<=3.6) - pip3 + + # Install ## Basic Installation @@ -157,3 +159,32 @@ sudo mv macOSBigSur /usr/share/icons/ 6. Click "**apply**" and "**ok**". ## Manual Install + +> Make sure you have installed all [Build dependencies](#build-dependencies). + +### ⚡ Auto Build (using GitHub Actions) + +GitHub Actions is automatically runs on every `push`(on **master** and **dev** branchs) and `pull request`(on **master** branch), You found theme resources in `artifact` section of **build**.You found all **Actions** in [.github/workflows](https://github.com/ful1e5/apple_cursor/tree/master/.github/workflows) directory. + +### Build + +```bash +# This command setup python virtual environment && install all packages +yarn setup +# Build & Unpack built cursor theme +yarn compile && yarn unpack +``` + +After build `bitmaps` and `packages` are generated at project root directory. + +### Install Build Cursor + +All builded cursor packages are available inside `packages` directory. + +```bash +cd ./packages +# Unpack .tar archive +mkdir macOSBigSur && tar -xvf macOSBigSur.tar -C macOSBigSur +# clean old version & install new build version to local user (recommended) +rm -rf ~/.icons/macOSBigSur && cp macOSBigSur ~/.icons/ +```