From 07cbfea8fa8f2e5324feb4478137140a26935ca3 Mon Sep 17 00:00:00 2001 From: tastytea Date: Sun, 19 Feb 2023 21:10:53 +0100 Subject: [PATCH] move contributing hints and todo list into main readme using `include::` stopped working --- CONTRIBUTING.adoc | 30 ------------------------- README.adoc | 57 +++++++++++++++++++++++++++++++++++++++++++++-- TODO.adoc | 28 ----------------------- 3 files changed, 55 insertions(+), 60 deletions(-) delete mode 100644 CONTRIBUTING.adoc delete mode 100644 TODO.adoc diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc deleted file mode 100644 index 2daa12f..0000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1,30 +0,0 @@ -:project: gentoo-xcursors -:uri-base: https://schlomp.space/tastytea/{project} -:uri-coc: {uri-base}/src/branch/main/CODE_OF_CONDUCT.adoc -:contact-email: tastytea@tastytea.de -:uri-git-format-patch: https://git-scm.com/docs/git-format-patch -:uri-git-send-email: https://git-scm.com/docs/git-send-email - -== How to contribute - -Read the link:{uri-coc}[Code of Conduct]. - -=== Reporting bugs or suggesting enhancements - -Before reporting a bug, please -https://schlomp.space/tastytea/{project}/issues[perform a search] to see if the -problem has already been reported. If it has, add a comment to the existing -issue or use reaction-emojis instead of opening a new one. Same for -enhancements. - -You can also contact me via mailto:{contact-email}[E-Mail] if you don't want to -open an account. - -=== Pull requests - -Please use the same color theme as the rest of the cursors. If you add or modify -a cursor or alias, please do so in all variants. - -You can also send me your patches via mailto:{contact-email}[E-Mail], ideally -using link:{uri-git-format-patch}[git format-patch] or -link:{uri-git-send-email}[git send-email]. diff --git a/README.adoc b/README.adoc index 1b181e1..96a5527 100644 --- a/README.adoc +++ b/README.adoc @@ -45,6 +45,59 @@ available sizes are 16, 24, 32, 48 and 64. gentoo-xcursors is licensed under the MIT license. See link:{uri-branch-main}/LICENSE[LICENSE] for details. -include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[] +== How to contribute +:uri-coc: {uri-branch-main}/CODE_OF_CONDUCT.adoc +:contact-email: tastytea@tastytea.de +:uri-git-format-patch: https://git-scm.com/docs/git-format-patch +:uri-git-send-email: https://git-scm.com/docs/git-send-email -include::{uri-base}/raw/branch/main/TODO.adoc[] +Read the link:{uri-coc}[Code of Conduct]. + +=== Reporting bugs or suggesting enhancements + +Before reporting a bug, please +https://schlomp.space/tastytea/{project}/issues[perform a search] to see if the +problem has already been reported. If it has, add a comment to the existing +issue or use reaction-emojis instead of opening a new one. Same for +enhancements. + +You can also contact me via mailto:{contact-email}[e-mail] if you don't want to +open an account. + +=== Pull requests + +Please use the same color theme as the rest of the cursors. If you add or modify +a cursor or alias, please do so in all variants. + +You can also send me your patches via mailto:{contact-email}[e-mail], ideally +using link:{uri-git-format-patch}[git format-patch] or +link:{uri-git-send-email}[git send-email]. + +== To do + +=== (Re-)create source files + +Since we don't have the sources, creating new cursors or modifying them is not +gonna be easy. Possible solutions are to (semi-automatically?) create SVGs from +the X11 cursors, start from scratch, or work directly with the X11 cursors. +Ideas are welcome. + +=== Prettier preview + +The script used for preview generation does not yield the best results. If you +know how to generate them without loosing quality, please let us know. + +=== Missing cursors + +NOTE: dnd = Drag and drop + +* bd_double_arrow a.k.a. nwse-resize a.k.a. size_fdiag + a.k.a. c7088f0f3e6c8088236ef8e1e3e70000 +* fd_double_arrow a.k.a. nesw-resize a.k.a. size_bdiag + a.k.a. fcf1c3c7cd4491d801f1e1c78f100000 +* crossed_circle a.k.a. not-allowed a.k.a. 03b6e0fcb3499374a867c041f52298f0 +* copy a.k.a. dnd-copy a.k.a. 1081e37283d90000800003c07f3ef6bf + a.k.a. 6407b0e94181790501fd1e167b474872 +* link a.k.a. dnd-link a.k.a. alias a.k.a. 3085a0e285430894940527032f8b26df + a.k.a. 640fb0e74195791501fd1ed57b41487f +* no-drop a.k.a. dnd-no-drop diff --git a/TODO.adoc b/TODO.adoc deleted file mode 100644 index 4635dba..0000000 --- a/TODO.adoc +++ /dev/null @@ -1,28 +0,0 @@ -== To do - -=== (Re-)create source files - -Since we don't have the sources, creating new cursors or modifying them is not -gonna be easy. Possible solutions are to (semi-automatically?) create SVGs from -the X11 cursors, start from scratch, or work directly with the X11 cursors. -Ideas are welcome. - -=== Prettier preview - -The script used for preview generation does not yield the best results. If you -know how to generate them without loosing quality, please let us know. - -=== Missing cursors - -NOTE: dnd = Drag and drop - -* bd_double_arrow a.k.a. nwse-resize a.k.a. size_fdiag - a.k.a. c7088f0f3e6c8088236ef8e1e3e70000 -* fd_double_arrow a.k.a. nesw-resize a.k.a. size_bdiag - a.k.a. fcf1c3c7cd4491d801f1e1c78f100000 -* crossed_circle a.k.a. not-allowed a.k.a. 03b6e0fcb3499374a867c041f52298f0 -* copy a.k.a. dnd-copy a.k.a. 1081e37283d90000800003c07f3ef6bf - a.k.a. 6407b0e94181790501fd1e167b474872 -* link a.k.a. dnd-link a.k.a. alias a.k.a. 3085a0e285430894940527032f8b26df - a.k.a. 640fb0e74195791501fd1ed57b41487f -* no-drop a.k.a. dnd-no-drop