👷 Build Docs Improved

This commit is contained in:
ful1e5 2020-08-11 16:52:42 +05:30
parent b885fa3418
commit a34dc70a35

View file

@ -83,9 +83,10 @@ Enjoy upcoming **[macOS BigSur](https://www.apple.com/macos/big-sur-preview/)**
- [Dependencies](#dependencies) - [Dependencies](#dependencies)
- [Runtime Dependencies](#runtime-dependencies) - [Runtime Dependencies](#runtime-dependencies)
- [Build Dependencies](#build-dependencies) - [Build Dependencies](#build-dependencies)
- [Install](#install) - [Build From Scrach](#build-from-scratch)
- [Basic Installation](basic-installation) - [⚡ Auto Build (using GitHub Actions)](#⚡-auto-build-using-gitHub-actions)
- [Manual Installation](#manual-install) - [Manual Build](#manual-build)
- [Install Build Theme](#install-build-theme)
- [Bugs](#bugs) - [Bugs](#bugs)
- [Getting Help](#getting-help) - [Getting Help](#getting-help)
- [Contributing](#contributing) - [Contributing](#contributing)
@ -179,31 +180,7 @@ bash <(wget -qO- "https://raw.githubusercontent.com/ful1e5/apple_cursor/master/s
- python (<=3.6) - python (<=3.6)
- pip3 - pip3
<!-- Install --> ## Build From Scratch
# Install
## Basic Installation
Download latest `stable` & `development` from [here](https://github.com/ful1e5/apple_cursor/releases) according to your **OS**.
### Linux/X11
<!-- Install Video -->
<!-- <p align="center">
<video src="https://i.imgur.com/zIF1JkH.mp4" width="75%" autoplay loop preload></video>
</p> -->
```bash
# Unpack
mkdir macOSBigSur && tar -xvf macOSBigSur.tar -C macOSBigSur
# For local users
mv macOSBigSur ~/.icons/
# For all users
sudo mv macOSBigSur /usr/share/icons/
```
## Manual Installation
> Make sure you have installed all [Build dependencies](#build-dependencies). > Make sure you have installed all [Build dependencies](#build-dependencies).
@ -211,7 +188,7 @@ sudo mv macOSBigSur /usr/share/icons/
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/apple_cursor/tree/master/.github/workflows) directory. 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/apple_cursor/tree/master/.github/workflows) directory.
### Build ### Manual Build
```bash ```bash
# This command setup python virtual environment && install all packages # This command setup python virtual environment && install all packages
@ -222,12 +199,12 @@ yarn compile && yarn unpack
After build `bitmaps` and `packages` are generated at project root directory. After build `bitmaps` and `packages` are generated at project root directory.
### Install Build Cursor ### Install Build Theme
#### Linux
All builded cursor packages are available inside `packages` directory. All builded cursor packages are available inside `packages` directory.
#### Linux
```bash ```bash
cd ./packages cd ./packages
# Unpack .tar archive # Unpack .tar archive