mirrors/Bibata_Cursor
1
0
Fork 0
mirror of https://github.com/ful1e5/Bibata_Cursor.git synced 2025-05-28 14:04:22 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: tidy docs inside README.md

Browse source
This commit is contained in:
ful1e5 2021-11-20 14:59:40 +05:30
parent 330c970680
commit 096abde703
2 changed files with 13 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [Bibata Zebra](https://github.com/ful1e5/Bibata-Zebra-Cursor) link added inside README.md
- [Bibata Bee](https://github.com/ful1e5/Bibata-Bee-Cursor) link added inside README.md
- tidy docs inside `README.md`
### Changed

115
README.md
View file

@ -1,78 +1,10 @@
<!-- Branding -->
# Bibata Cursor
<p align="center">
<img src="https://imgur.com/cfkawDi.png" width="40%">
</p>
[![build](https://github.com/ful1e5/Bibata_Cursor/actions/workflows/build.yml/badge.svg)](https://github.com/ful1e5/Bibata_Cursor/actions/workflows/build.yml)
[![CodeFactor](https://www.codefactor.io/repository/github/ful1e5/bibata_cursor/badge)](https://www.codefactor.io/repository/github/ful1e5/bibata_cursor)
[![Twitter](https://img.shields.io/badge/twitter-ful1e5-blue)](https://twitter.com/ful1e5)
<p align="center">
<b>Material Based Cursors</b> 🚀
</p>
<!-- Badges -->
<p align="center">
<!-- First Row -->
<a href="https://github.com/ful1e5/Bibata_Cursor/actions?query=workflow%3Abibata-ci">
<img alt="GitHub Action Build" src="https://github.com/ful1e5/Bibata_Cursor/workflows/bibata-ci/badge.svg"/>
</a>
<a href="https://www.codefactor.io/repository/github/ful1e5/bibata_cursor">
<img src="https://www.codefactor.io/repository/github/ful1e5/bibata_cursor/badge" alt="CodeFactor" />
</a>
<!-- Second Row -->
</br >
<a href="https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html">
<img alt="npm type definitions" src="https://img.shields.io/npm/types/typescript">
</a>
<a href="https://github.com/ful1e5/clickgen">
<img alt="Clickgen" src="https://img.shields.io/badge/theme%20builder-clickgen-FD0542" />
</a>
<!-- Third Row -->
</br >
<a href="https://github.com/ful1e5/Bibata_Cursor/blob/main/LICENSE" >
<img alt="License" src="https://img.shields.io/github/license/ful1e5/Bibata_Cursor?color=0081FB" />
</a>
<a href="https://github.com/ful1e5/Bibata_Cursor/releases" >
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/ful1e5/Bibata_Cursor">
</a>
<a href="https://aur.archlinux.org/packages/bibata-cursor-theme" >
<img alt="AUR version" src="https://img.shields.io/aur/version/bibata-cursor-theme">
</a>
<!-- Fourth Row -->
<br />
<a href="https://www.pling.com/p/1197198/#files-panel">
<img alt="License" src="https://img.shields.io/badge/-Linux-grey?logo=linux" />
</a>
<a href="https://www.pling.com/p/1197198/#files-panel">
<img alt="License" src="https://img.shields.io/badge/-Windows-blue?logo=windows" />
</a>
<!-- Fifth Row -->
<br />
<a href="https://github.com/ful1e5">
<img alt="Made By Kaiz" src="https://kaiz.vercel.app/api/badge" width="133" />
</a>
</p>
---
# Bibata ?
Bibata is **OpenSource**, Compact and Material Designed Cursor set. This project masterelop for improve `Cursor` Experience.
Bibata is **OpenSource**, compact, and material designed cursor set. This project masterelop for improve `Cursor` experience.
- **Bibata Amber :** Yellowish Theme.
- **Bibata Classic :** Solid Black Theme.
@ -104,7 +36,13 @@ Bibata is **OpenSource**, Compact and Material Designed Cursor set. This project
![Classic](https://imgur.com/I5cRKE4.png)
![Ice ✓](https://imgur.com/avnR40g.png)
<!-- Preview -->
## Quick install
<p align="center">
<a href="https://www.pling.com/p/1197198/" >
<img title="Bibata Pling Store" width="40%" src="https://imgur.com/VxSgrWw.png">
</a>
</p>
## Preview
@ -128,14 +66,6 @@ Bibata is **OpenSource**, Compact and Material Designed Cursor set. This project
<sub>Bibata Ice</sub>
</p>
## Quick install
<p align="center">
<a href="https://www.pling.com/p/1197198/" >
<img title="Bibata Pling Store" width="40%" src="https://imgur.com/VxSgrWw.png">
</a>
</p>
## Packages
> **Note**: If you're having trouble with the packages please submit a request to the package maintainer before creating an issue.
@ -213,8 +143,6 @@ sudo mv Bibata-* /usr/share/icons/
4. Open _Control Panel_ > _Personalization and Appearance_ > _Change mouse pointers_, and select **Bibata Cursors**.
5. Click '**Apply**'.
<!-- Build Dependencies -->
# Dependencies
## External Libraries
@ -318,8 +246,6 @@ make windows WIN_SIZE=96 # Supports only one pixel-size
> Windows installations steps are same as [these](#windows).
<!-- Other Interesting projects -->
# You may also like...
- [**Bibata Adapta**](https://gitlab.com/cscs/Bibata_AdaptaBreath_Cursors) - Bibata Based Cursor Made for AdaptaBreath and Manjaro.
@ -329,26 +255,18 @@ make windows WIN_SIZE=96 # Supports only one pixel-size
- [**Bibata Bee**](https://github.com/ful1e5/Bibata-Bee-Cursor) - 'Semi-Animated' Bibata cursors with bee stripes
- [**Bibata Translucent**](https://github.com/Silicasandwhich/Bibata_Cursor_Translucent) - Bibata translucent is a translucent flavor of the Bibata.
<!-- Bug Report -->
# Bugs
Bugs should be reported [here](https://github.com/ful1e5/Bibata_Cursor/issues) on the Github issues page.
<!-- Help -->
# Getting Help
You can create a **issue**, I will help you. 🙂
<!-- Contributions and Suggestion -->
# Contributing
Check [CONTRIBUTING.md](CONTRIBUTING.md), any suggestions for features and contributions to the continuing code masterelopment can be made via the issue tracker or code contributions via a `Fork` & `Pull requests`.
<!-- This project isn't possible without these 👇🏻-->
# Credit
- [Adwaita](https://github.com/GNOME/adwaita-icon-theme)
@ -356,12 +274,3 @@ Check [CONTRIBUTING.md](CONTRIBUTING.md), any suggestions for features and contr
- [Yaru](https://github.com/ubuntu/yaru)
- Emojis are taken from [here](https://emojipedia.org/)
- Wedge loading from [loading.io](https://loading.io/spinner/wedges/-pie-wedge-pizza-circle-round-rotate) with **Microsoft** colors
<!-- Ninja -->
<p align="center">
<h1 align="center">(◣_◢)</h1>
</p>
<p align="center">
<sub>Stop <strong>scrolling</strong>, It's <strong>hurt</strong> me</sub>
</p>