diff --git a/FAQ.md b/FAQ.md index fd8cbec..d010a47 100644 --- a/FAQ.md +++ b/FAQ.md @@ -2,14 +2,9 @@ ## How do I do a particular thing with cagebreak? - * Check the man pages - * [cagebreak config](man/cagebreak-config.5.md) (probably where you find the answer) - * [cagebreak](man/cagebreak.1.md) (command line options etc.) - * [cagebreak-socket](man/cagebreak-socket.7.md) (socket information, mostly useful for scritping) - * Check the rest of this FAQ - * [Open an issue](https://github.com/project-repo/cagebreak/issues/new) or otherwise get in touch with the development team (See section Email Contact in [SECURITY.md](SECURITY.md)). - -Note that the feature set of cagebreak is intentionally limited. + * Check the [man pages](manuals.md). + * Check the rest of this file. + * [Open an issue](https://github.com/project-repo/cagebreak/issues/new) or get in touch (See section Email Contact in [SECURITY.md](SECURITY.md)). ## How do I remap Caps Lock? diff --git a/README.md b/README.md index 0153691..b91e2a5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6532/badge)](https://bestpractices.coreinfrastructure.org/projects/6532) [![Packaging status](https://repology.org/badge/tiny-repos/cagebreak.svg)](https://repology.org/project/cagebreak/versions) [![AUR package](https://repology.org/badge/version-for-repo/aur/cagebreak.svg?minversion=2.3.0)](https://repology.org/project/cagebreak/versions) +[Open Issue](https://github.com/project-repo/cagebreak/issues/new) [Contact](SECURITY.md) [Manuals](manuals.md) [FAQ](FAQ.md) [CONTRIBUTING](CONTRIBUTING.md) [ArchWiki](https://wiki.archlinux.org/title/Cagebreak) [AUR](https://aur.archlinux.org/packages?O=0&K=cagebreak) [License](LICENSE) [GitHub](https://github.com/project-repo/cagebreak) + ## Quick Introduction Cagebreak is a [Wayland](https://wayland.freedesktop.org/) tiling compositor @@ -38,7 +40,7 @@ details on getting started and the documentation for everything else. ### Documentation - * the man pages: [cagebreak](man/cagebreak.1.md), [configuration](man/cagebreak-config.5.md) & [socket](man/cagebreak-socket.7.md) + * [the man pages](manuals.md) * the [README](README.md), [FAQ](FAQ.md) & [SECURITY.md](SECURITY.md) #### What's new? diff --git a/manuals.md b/manuals.md new file mode 100644 index 0000000..dd5f84b --- /dev/null +++ b/manuals.md @@ -0,0 +1,5 @@ +# Cagebreak Manuals + + * [cagebreak-config (5)](man/cagebreak-config.5.md) (probably, what you are looking for, commands etc.) + * [cagebreak (1)](man/cagebreak.1.md) (command line arguments, environment variables etc.) + * [cagebreak-socket (7)](man/cagebreak-socket.7.md) (mostly useful for scripting, socket information)