🧑‍💻 Build docs updated

This commit is contained in:
ful1e5 2021-01-30 18:11:55 +05:30
parent a2e5dbecde
commit eadf06538a
2 changed files with 39 additions and 48 deletions

View file

@ -74,37 +74,36 @@ Enjoy upcoming **[macOS BigSur](https://www.apple.com/macos/big-sur-preview/)**
<details> <details>
<summary><strong>Table of Contents</strong> (click to expand)</summary> <summary><strong>Table of Contents</strong> (click to expand)</summary>
- [Apple Cursor](#apple-cursor) - [Apple Cursor](#apple-cursor)
- [Cursor Sizes](#cursor-sizes) - [Cursor Sizes](#cursor-sizes)
- [Colors](#colors) - [Colors](#colors)
- [Quick install](#quick-install) - [Quick install](#quick-install)
- [Manual Install](#manual-install) - [Manual Install](#manual-install)
- [Linux/X11](#linuxx11) - [Linux/X11](#linuxx11)
- [Windows](#windows) - [Windows](#windows)
- [Preview:](#preview) - [Preview:](#preview)
- [Dependencies](#dependencies) - [Dependencies](#dependencies)
- [External Libraries](#external-libraries) - [External Libraries](#external-libraries)
- [Install External Libraries](#install-external-libraries) - [Install External Libraries](#install-external-libraries)
- [macOS](#macos) - [macOS](#macos)
- [Debain/ubuntu](#debainubuntu) - [Debain/ubuntu](#debainubuntu)
- [ArchLinux/Manjaro](#archlinuxmanjaro) - [ArchLinux/Manjaro](#archlinuxmanjaro)
- [Fedora/Fedora Silverblue/CentOS/RHEL](#fedorafedora-silverbluecentosrhel) - [Fedora/Fedora Silverblue/CentOS/RHEL](#fedorafedora-silverbluecentosrhel)
- [Build Dependencies](#build-dependencies) - [Build Dependencies](#build-dependencies)
- [Node Packages](#node-packages) - [Node Packages](#node-packages)
- [PyPi Packages](#pypi-packages) - [PyPi Packages](#pypi-packages)
- [Build From Scratch](#build-from-scratch) - [Build From Scratch](#build-from-scratch)
- [⚡ Auto Build (using GitHub Actions)](#-auto-build-using-github-actions) - [⚡ Auto Build (using GitHub Actions)](#-auto-build-using-github-actions)
- [Manual Build](#manual-build) - [Manual Build](#manual-build)
- [Setup python environment](#setup-python-environment) - [Build only `XCursor` theme](#build-only-xcursor-theme)
- [Compile From Source](#compile-from-source) - [Build only `Windows` theme](#build-only-windows-theme)
- [Using yarn](#using-yarn) - [Install Build Theme](#install-build-theme)
- [Install Build Theme](#install-build-theme) - [Linux](#linux)
- [Linux](#linux) - [Windows](#windows-1)
- [Windows](#windows-1) - [Bugs](#bugs)
- [Bugs](#bugs) - [Getting Help](#getting-help)
- [Getting Help](#getting-help) - [Contributing](#contributing)
- [Contributing](#contributing) - [Support](#support)
- [Support](#support)
</details> </details>
@ -241,39 +240,31 @@ GitHub Actions is automatically runs on every `push`(on **main** and **dev** bra
### Manual Build ### Manual Build
#### Setup python environment
```bash ```bash
python3 -m pip install --upgrade pip # Update pip to latest make
python3 -m venv venv # Create new virtualenv named `venv`
source venv/bin/activate # Activate virtualenv
deactivate # For Deactivate virtualenv
``` ```
#### Compile From Source #### Build only `XCursor` theme
> Make sure your [python environment](#setup-python-environment) setup and `virtualenv` is **active**.
##### Using yarn
```bash ```bash
yarn install # Install all Node Packages make unix
yarn py_install # Install all PyPi Packages
yarn compile # Compile the cursor theme
``` ```
After build, `bitmaps` and `themes` directory are generated at project **root**. #### Build only `Windows` theme
```bash
make windows
```
### Install Build Theme ### Install Build Theme
Built cursor themes are available inside `themes` directory. Built cursor themes are available inside `themes` directory.
#### Linux #### Linux
```bash ```bash
cd ./themes make install # install as local level
rm -rf ~/.icons/macOSBigSur && cp macOSBigSur ~/.icons/ # installing Theme to local user(recommended)
sudo make install # install as root level
``` ```
#### Windows #### Windows

View file

@ -49,7 +49,7 @@ args = parser.parse_args()
bitmaps_dir = Path(args.png_dir) bitmaps_dir = Path(args.png_dir)
x_out_dir = Path(args.out_dir) / "macOSBigSur" x_out_dir = Path(args.out_dir) / "macOSBigSur"
win_out_dir = Path(args.out_dir) / "macOSBigSur-Windows" win_out_dir = Path(args.out_dir) / "macOSBigSur_Windows"
if args.platform == "unix": if args.platform == "unix":
xbuild(bitmaps_dir, x_out_dir) xbuild(bitmaps_dir, x_out_dir)