diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f5ccd91 --- /dev/null +++ b/LICENSE @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +[Except as contained in this notice, the name of the copyright holders +shall not be used in advertising or otherwise to promote the sale, use +or other dealings in this Software without prior written authorization +from the copyright holders.] diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..c98d77f --- /dev/null +++ b/README.adoc @@ -0,0 +1,37 @@ += gentoo-xcursors +:toc: preamble +:project: gentoo-xcursors +:uri-base: https://schlomp.space/tastytea/{project} +:uri-branch-main: {uri-base}/src/branch/main + +A high quality set of animated mouse cursors. + +The original authors are unknownfootnote:[If you are one of the authors, please +get in touch so that you can be properly attributed.], the source of the initial +commit is the file `gentoo-cursors-tad-0.3.1.tar.bz2` from the Gentoo +mirrors. If you have the source files used to generate the cursors, please get +in touch. + +== Install + +=== Gentoo + +[source,shell] +-------------------------------------------------------------------------------- +emerge -a x11-themes/gentoo-xcursors +-------------------------------------------------------------------------------- + +=== Other + +Copy the contents of `cursors/` into `/usr/share/cursors/xorg-x11/cursors/` or +`~/.icons/`. + +== Configuration + +See https://wiki.gentoo.org/wiki/Cursor_themes[Gentoo Wiki: Cursor themes]. The +available sizes are 16, 24, 32, 48 and 64. + +== License + +gentoo-xcursors is licensed under the MIT license. See +link:{uri-branch-main}/LICENSE[LICENSE] for details.