meta: Clean-up readme and contributing files.

luleyleo · Sep 6, 2024 · fd67b49 · fd67b49
1 parent 5f8ca24
commit fd67b49
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git 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
@@ -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).