🧑‍💻 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

@ -95,9 +95,8 @@ Enjoy upcoming **[macOS BigSur](https://www.apple.com/macos/big-sur-preview/)**
- [Build From Scratch](#build-from-scratch)
- [⚡ Auto Build (using GitHub Actions)](#-auto-build-using-github-actions)
- [Manual Build](#manual-build)
- [Setup python environment](#setup-python-environment)
- [Compile From Source](#compile-from-source)
- [Using yarn](#using-yarn)
- [Build only `XCursor` theme](#build-only-xcursor-theme)
- [Build only `Windows` theme](#build-only-windows-theme)
- [Install Build Theme](#install-build-theme)
- [Linux](#linux)
- [Windows](#windows-1)
@ -241,39 +240,31 @@ GitHub Actions is automatically runs on every `push`(on **main** and **dev** bra
### Manual Build
#### Setup python environment
```bash
python3 -m pip install --upgrade pip # Update pip to latest
python3 -m venv venv # Create new virtualenv named `venv`
source venv/bin/activate # Activate virtualenv
deactivate # For Deactivate virtualenv
make
```
#### Compile From Source
> Make sure your [python environment](#setup-python-environment) setup and `virtualenv` is **active**.
##### Using yarn
#### Build only `XCursor` theme
```bash
yarn install # Install all Node Packages
yarn py_install # Install all PyPi Packages
yarn compile # Compile the cursor theme
make unix
```
After build, `bitmaps` and `themes` directory are generated at project **root**.
#### Build only `Windows` theme
```bash
make windows
```
### Install Build Theme
Built cursor themes are available inside `themes` directory.
#### Linux
```bash
cd ./themes
rm -rf ~/.icons/macOSBigSur && cp macOSBigSur ~/.icons/ # installing Theme to local user(recommended)
make install # install as local level
sudo make install # install as root level
```
#### Windows

View file

@ -49,7 +49,7 @@ args = parser.parse_args()
bitmaps_dir = Path(args.png_dir)
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":
xbuild(bitmaps_dir, x_out_dir)