Skip to content

Commit

Permalink
Add x2wincur to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
quantum5 committed Oct 3, 2020
1 parent c2d03cd commit ad6a6d7
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand All @@ -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/
Expand All @@ -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/

0 comments on commit ad6a6d7

Please sign in to comment.