From fd67b49c9b722c54213581e874baa59a880dd620 Mon Sep 17 00:00:00 2001 From: Leopold Luley Date: Fri, 6 Sep 2024 12:44:37 +0200 Subject: [PATCH] meta: Clean-up readme and contributing files. --- CONTRIBUTING.md | 9 ++++++++- README.md | 7 ++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 560e36d..c87ba99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,13 @@ # Contributing -A brief overview of dependencies and build instructions. +A brief overview over the project, its dependencies and build instructions. + +## Modules + +Clapgrep consists of two modules: + +- core, which contains the search logic. +- gnome, which is a Gtk + Adwaita frontend. ## Requirements (for Fedora toolbox) diff --git a/README.md b/README.md index e7b47cd..b3d3d3c 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,6 @@ Clapgrep can currently search all sorts of text files, PDFs and Office documents ![screenshot of the app](assets/screenshot-1.png) -## Modules +## Contributing -Clapgrep consists of two modules: - -- core, which contains the search logic. -- gnome, which is a Gtk + Adwaita frontend. +See [Contributing](/CONTRIBUTING.md).