prepare v1.0.0

skippyr · skippyr · commit b2c5abc7b795 · 2024-01-19T18:03:49.000-03:00
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2024, Sherman Rofeman
+Copyright (c) 2024, Sherman Rofeman <skippyr.developer@gmail.com>
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
diff --git a/Makefile b/Makefile
@@ -0,0 +1,25 @@
+ICONSPATH:=~/.local/share/icons
+
+.PHONY: all clean install uninstall
+
+all: xcapy
+
+clean:
+	rm -rf xcapy;
+
+install: all
+	mkdir -p ${ICONSPATH};
+	cp -r xcapy ${ICONSPATH};
+
+uninstall:
+	rm -rf ${ICONSPATH}/xcapy;
+
+xcapy:
+	mkdir -p xcapy/cursors;
+	cp index.theme LICENSE xcapy;
+	cp -d src/symlinks/* xcapy/cursors;
+	for c in $(wildcard src/*.cfg);\
+	do\
+		f=$${c##*/};\
+		xcursorgen $${c} > xcapy/cursors/$${f%.*};\
+	done
diff --git a/README.md b/README.md
@@ -0,0 +1,102 @@
+<p align="center">
+	<img src="banner.webp" alt="" />
+</p>
+<h1 align="center">⊼⊵⊼⊵&ensp;xcapy&ensp;⊼⊵⊼⊵</h1>
+<p align="center">
+	<img src="https://img.shields.io/github/license/skippyr/xcapy" alt="" />
+	<img src="https://img.shields.io/github/v/tag/skippyr/xcapy" alt="" />
+	<img src="https://img.shields.io/github/commit-activity/t/skippyr/xcapy" alt="" />
+	<img src="https://img.shields.io/github/stars/skippyr/xcapy" alt="" />
+</p>
+
+## ❡ About
+
+A simple 32x32 pixels cursor for Linux that has a tribal inspired style.
+
+<p align="center">
+	<img src="src/left_ptr.png" alt="" />
+	<img src="src/hand2.png" alt="" />
+	<img src="src/progress.png" alt="" />
+	<img src="src/watch.png" alt="" />
+	<img src="src/help.png" alt="" />
+	<img src="src/link.png" alt="" />
+	<img src="src/not-allowed.png" alt="" />
+	<br />
+	<img src="src/xterm.png" alt="" />
+	<img src="src/vertical-text.png" alt="" />
+	<br />
+	<img src="src/all-scroll.png" alt="" />
+	<img src="src/ns-resize.png" alt="" />
+	<img src="src/ew-resize.png" alt="" />
+	<img src="src/nesw-resize.png" alt="" />
+	<img src="src/nwse-resize.png" alt="" />
+	<br />
+	<img src="src/zoom-in.png" alt="" />
+	<img src="src/zoom-out.png" alt="" />
+</p>
+<p align="center"><sup><strong>Caption:</strong> a preview of the different states of the cursor.</sup></p>
+
+## ❡ Install
+
+### Dependencies
+
+The following dependencies are required to install it:
+
+&emsp;**1.**&ensp;**git**: it will be used to clone this repository.\
+&emsp;**2.**&ensp;**xcursorgen**, **make**: they will be used to build and install it.
+
+### Procedures
+
+Using a terminal, follow these steps:
+
+&emsp;**1.**&ensp;Clone this repository using git:
+
+```sh
+git clone https://github.com/skippyr/xcapy;
+```
+
+&emsp;**2.**&ensp;Access the repository directory using cd:
+
+```sh
+cd xcapy;
+```
+
+&emsp;**3.**&ensp;Use make to compile and install it:
+
+```sh
+make install clean;
+```
+
+&emsp;**4.**&ensp;Apply the theme using your system settings.
+
+&emsp;**5.**&ensp;Reopen your desktop session.
+
+
+## ❡ Uninstall
+
+Using a terminal, follow these steps:
+
+&emsp;**1.**&ensp;Go back to the repository directory.\
+&emsp;**2.**&ensp;Use make to uninstall it:
+
+```sh
+make uninstall;
+```
+
+## ❡ Help
+
+If you need help about this project, open a new issue in its [issues page](https://github.com/skippyr/xcapy/issues) or send me an [e-mail](mailto:skippyr.developer@gmail.com) describing what is going on.
+
+## ❡ Contributing
+
+This project is open to review and possibly accept contributions, specially fixes and suggestions. If you are interested, send your contribution to its [pull requests page](https://github.com/skippyr/xcapy/pulls) or to my [e-mail](mailto:skippyr.developer@gmail.com).
+
+By contributing to this project, you must agree to license your work under the same license that the project uses.
+
+## ❡ License
+
+This project is licensed under the BSD-3-Clause License. Refer to the LICENSE file that comes in its source code for license and copyright details.
+
+&nbsp;
+
+<p align="center"><sup><strong>⊼⊵⊼⊵&ensp;Here Are Dragons!&ensp;⊼⊵⊼⊵</strong><br />Made with love by skippyr <3</sup></p>
diff --git a/banner.webp b/banner.webp
diff --git a/index.theme b/index.theme
@@ -0,0 +1,2 @@
+[Icon Theme]
+Name=xcapy
diff --git a/src/all-scroll.cfg b/src/all-scroll.cfg
@@ -0,0 +1 @@
+32 16 16 src/all-scroll.png 0
diff --git a/src/all-scroll.png b/src/all-scroll.png
diff --git a/src/ew-resize.cfg b/src/ew-resize.cfg
@@ -0,0 +1 @@
+32 16 16 src/ew-resize.png 0
diff --git a/src/ew-resize.png b/src/ew-resize.png
diff --git a/src/hand2.cfg b/src/hand2.cfg
@@ -0,0 +1 @@
+32 12 6 src/hand2.png 0
diff --git a/src/hand2.png b/src/hand2.png
diff --git a/src/help.cfg b/src/help.cfg
@@ -0,0 +1 @@
+32 6 9 src/help.png 0
diff --git a/src/help.png b/src/help.png
diff --git a/src/left_ptr.cfg b/src/left_ptr.cfg
@@ -0,0 +1 @@
+32 11 9 src/left_ptr.png 0
diff --git a/src/left_ptr.png b/src/left_ptr.png
diff --git a/src/link.cfg b/src/link.cfg
@@ -0,0 +1 @@
+32 6 9 src/link.png 0
diff --git a/src/link.png b/src/link.png
diff --git a/src/nesw-resize.cfg b/src/nesw-resize.cfg
@@ -0,0 +1 @@
+32 16 16 src/nesw-resize.png 0
diff --git a/src/nesw-resize.png b/src/nesw-resize.png
diff --git a/src/not-allowed.cfg b/src/not-allowed.cfg
@@ -0,0 +1 @@
+32 16 16 src/not-allowed.png 0
diff --git a/src/not-allowed.png b/src/not-allowed.png
diff --git a/src/ns-resize.cfg b/src/ns-resize.cfg
@@ -0,0 +1 @@
+32 16 16 src/ns-resize.png 0
diff --git a/src/ns-resize.png b/src/ns-resize.png
diff --git a/src/nwse-resize.cfg b/src/nwse-resize.cfg
@@ -0,0 +1 @@
+32 16 16 src/nwse-resize.png 0
diff --git a/src/nwse-resize.png b/src/nwse-resize.png
diff --git a/src/progress.cfg b/src/progress.cfg
@@ -0,0 +1 @@
+32 6 9 src/progress.png 0
diff --git a/src/progress.png b/src/progress.png
diff --git a/src/symlinks/alias b/src/symlinks/alias
@@ -0,0 +1 @@
+link
diff --git a/src/symlinks/bottom_left_corner b/src/symlinks/bottom_left_corner
@@ -0,0 +1 @@
+nesw-resize
diff --git a/src/symlinks/bottom_right_corner b/src/symlinks/bottom_right_corner
@@ -0,0 +1 @@
+nwse-resize
diff --git a/src/symlinks/bottom_side b/src/symlinks/bottom_side
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/cell b/src/symlinks/cell
@@ -0,0 +1 @@
+all-scroll
diff --git a/src/symlinks/col-resize b/src/symlinks/col-resize
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/context-menu b/src/symlinks/context-menu
@@ -0,0 +1 @@
+help
diff --git a/src/symlinks/copy b/src/symlinks/copy
@@ -0,0 +1 @@
+link
diff --git a/src/symlinks/crosshair b/src/symlinks/crosshair
@@ -0,0 +1 @@
+all-scroll
diff --git a/src/symlinks/dnd-ask b/src/symlinks/dnd-ask
@@ -0,0 +1 @@
+help
diff --git a/src/symlinks/dnd-copy b/src/symlinks/dnd-copy
@@ -0,0 +1 @@
+link
diff --git a/src/symlinks/dnd-no-drop b/src/symlinks/dnd-no-drop
@@ -0,0 +1 @@
+not-allowed
diff --git a/src/symlinks/dnd-none b/src/symlinks/dnd-none
@@ -0,0 +1 @@
+not-allowed
diff --git a/src/symlinks/e-resize b/src/symlinks/e-resize
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/fleur b/src/symlinks/fleur
@@ -0,0 +1 @@
+all-scroll
diff --git a/src/symlinks/grab b/src/symlinks/grab
@@ -0,0 +1 @@
+hand2
diff --git a/src/symlinks/half-busy b/src/symlinks/half-busy
@@ -0,0 +1 @@
+progress
diff --git a/src/symlinks/hand b/src/symlinks/hand
@@ -0,0 +1 @@
+hand2
diff --git a/src/symlinks/hand1 b/src/symlinks/hand1
@@ -0,0 +1 @@
+hand2
diff --git a/src/symlinks/ibeam b/src/symlinks/ibeam
@@ -0,0 +1 @@
+xterm
diff --git a/src/symlinks/left_ptr_watch b/src/symlinks/left_ptr_watch
@@ -0,0 +1 @@
+progress
diff --git a/src/symlinks/left_side b/src/symlinks/left_side
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/move b/src/symlinks/move
@@ -0,0 +1 @@
+all-scroll
diff --git a/src/symlinks/n-resize b/src/symlinks/n-resize
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/ne-resize b/src/symlinks/ne-resize
@@ -0,0 +1 @@
+nesw-resize
diff --git a/src/symlinks/no-drop b/src/symlinks/no-drop
@@ -0,0 +1 @@
+not-allowed
diff --git a/src/symlinks/nw-resize b/src/symlinks/nw-resize
@@ -0,0 +1 @@
+nwse-resize
diff --git a/src/symlinks/openhand b/src/symlinks/openhand
@@ -0,0 +1 @@
+hand2
diff --git a/src/symlinks/plus b/src/symlinks/plus
@@ -0,0 +1 @@
+all-scroll
diff --git a/src/symlinks/pointing_hand b/src/symlinks/pointing_hand
@@ -0,0 +1 @@
+left_ptr
diff --git a/src/symlinks/question_arrow b/src/symlinks/question_arrow
@@ -0,0 +1 @@
+help
diff --git a/src/symlinks/right_ptr b/src/symlinks/right_ptr
@@ -0,0 +1 @@
+left_ptr
diff --git a/src/symlinks/right_side b/src/symlinks/right_side
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/row-resize b/src/symlinks/row-resize
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/s-resize b/src/symlinks/s-resize
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/sb_h_double_arrow b/src/symlinks/sb_h_double_arrow
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/sb_v_double_arrow b/src/symlinks/sb_v_double_arrow
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/se-resize b/src/symlinks/se-resize
@@ -0,0 +1 @@
+nwse-resize
diff --git a/src/symlinks/size_bdiag b/src/symlinks/size_bdiag
@@ -0,0 +1 @@
+nesw-resize
diff --git a/src/symlinks/size_fdiag b/src/symlinks/size_fdiag
@@ -0,0 +1 @@
+nwse-resize
diff --git a/src/symlinks/size_hor b/src/symlinks/size_hor
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/size_ver b/src/symlinks/size_ver
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/sizing b/src/symlinks/sizing
@@ -0,0 +1 @@
+all-scroll
diff --git a/src/symlinks/split_h b/src/symlinks/split_h
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/split_v b/src/symlinks/split_v
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/sw-resize b/src/symlinks/sw-resize
@@ -0,0 +1 @@
+nesw-resize
diff --git a/src/symlinks/text b/src/symlinks/text
@@ -0,0 +1 @@
+xterm
diff --git a/src/symlinks/top_left_corner b/src/symlinks/top_left_corner
@@ -0,0 +1 @@
+nwse-resize
diff --git a/src/symlinks/top_right_corner b/src/symlinks/top_right_corner
@@ -0,0 +1 @@
+nesw-resize
diff --git a/src/symlinks/top_side b/src/symlinks/top_side
@@ -0,0 +1 @@
+ns-resize
diff --git a/src/symlinks/w-resize b/src/symlinks/w-resize
@@ -0,0 +1 @@
+ew-resize
diff --git a/src/symlinks/wait b/src/symlinks/wait
@@ -0,0 +1 @@
+progress
diff --git a/src/vertical-text.cfg b/src/vertical-text.cfg
@@ -0,0 +1 @@
+32 16 16 src/vertical-text.png 0
diff --git a/src/vertical-text.png b/src/vertical-text.png
diff --git a/src/watch.cfg b/src/watch.cfg
@@ -0,0 +1 @@
+32 16 16 src/watch.png 0
diff --git a/src/watch.png b/src/watch.png
diff --git a/src/xterm.cfg b/src/xterm.cfg
@@ -0,0 +1 @@
+32 16 16 src/xterm.png 0
diff --git a/src/xterm.png b/src/xterm.png
diff --git a/src/zoom-in.cfg b/src/zoom-in.cfg
@@ -0,0 +1 @@
+32 16 16 src/zoom-in.png 0
diff --git a/src/zoom-in.png b/src/zoom-in.png
diff --git a/src/zoom-out.cfg b/src/zoom-out.cfg
@@ -0,0 +1 @@
+32 16 16 src/zoom-out.png 0
diff --git a/src/zoom-out.png b/src/zoom-out.png
