quantum/win2xcur
1
0
Fork 0
mirror of https://github.com/quantum5/win2xcur.git synced 2025-04-24 10:11:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add x2wincur to README.md

Browse source
This commit is contained in:
Quantum 2020-10-03 01:56:26 -04:00
parent c2d03cd677
commit ad6a6d78c6
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,4 +1,4 @@
# `win2xcur` [![Build Status](https://img.shields.io/github/workflow/status/quantum5/win2xcur/Python%20package)](https://github.com/quantum5/win2xcur/actions) [![PyPI](https://img.shields.io/pypi/v/win2xcur.svg)](https://pypi.org/project/win2xcur/) [![PyPI - Format](https://img.shields.io/pypi/format/win2xcur.svg)](https://pypi.org/project/win2xcur/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/win2xcur.svg)](https://pypi.org/project/win2xcur/)
# `win2xcur` and `x2wincur` [![Build Status](https://img.shields.io/github/workflow/status/quantum5/win2xcur/Python%20package)](https://github.com/quantum5/win2xcur/actions) [![PyPI](https://img.shields.io/pypi/v/win2xcur.svg)](https://pypi.org/project/win2xcur/) [![PyPI - Format](https://img.shields.io/pypi/format/win2xcur.svg)](https://pypi.org/project/win2xcur/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/win2xcur.svg)](https://pypi.org/project/win2xcur/)
`win2xcur` is a tool that converts cursors from Windows format (`*.cur`,
`*.ani`) to Xcursor format. This allows Windows cursor themes to be used on
@ -8,6 +8,10 @@ Linux, for example.
hotspot and animation delay, and has an optional mode to add shadows that
replicates Windows's cursor shadow effect.
`x2wincur` is a tool that does the opposite: it converts cursors in the Xcursor
format to Windows format (`*.cur`, *.ani`), allowing to use your favourite
Linux cursor themes on Windows.
## Installation
To install the latest stable version:
@ -18,9 +22,10 @@ To install from GitHub:
pip install -e git+https://github.com/quantum5/win2xcur.git
## Usage
## Usage: `win2xcur`
For example, if you want to convert [the sample cursor](sample/crosshair.cur):
For example, if you want to convert [the sample cursor](sample/crosshair.cur)
to Linux format:
mkdir output/
win2xcur sample/crosshair.cur -o output/
@ -32,3 +37,10 @@ For example, to convert a directory of cursors with shadows enabled:
win2xcur input/*.{ani,cur} -o output/
For more information, run `win2xcur --help`.
## Usage: `x2wincur`
For example, if you want to convert DMZ-White to Windows:
mkdir dmz-white/
x2wincur /usr/share/icons/DMZ-White/cursors/* -o dmz-white/