Skip to content

Commit 6297f71

Browse files
committed
Update contributing instructions.
Closes #51.
1 parent def6e89 commit 6297f71

File tree

2 files changed

+7
-33
lines changed

2 files changed

+7
-33
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ Clapgrep consists of two modules:
99
- core, which contains the search logic.
1010
- gnome, which is a Gtk + Adwaita frontend.
1111

12-
## Requirements (for Fedora toolbox)
12+
## Requirements (for Fedora Rawhide toolbox)
1313

1414
For the build system and OpenGL support:
1515

1616
```sh
17-
sudo dnf install just cargo clippy gcc libglvnd-gles python3-aiohttp python3-toml
17+
sudo dnf install just meson appstream cargo clippy gcc libglvnd-gles
1818
```
1919

2020
For the Gtk based app:
@@ -25,34 +25,8 @@ sudo dnf install just gtk4-devel libadwaita-devel
2525

2626
And you have to install [blueprint-compiler](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/setup.html).
2727

28-
## Development
28+
## Compilation and Development
2929

30-
You can run the app with
31-
32-
```sh
33-
just run
34-
```
35-
36-
You can check for warnings with
37-
38-
```sh
39-
just check
40-
```
41-
42-
You can install the `.Devel` flatpak with
43-
44-
```sh
45-
just install-flatpak
46-
```
47-
48-
You can install the regular flatpak with
49-
50-
```sh
51-
just release=true install-flatpak
52-
```
53-
54-
And you can update the translation messages with
55-
56-
```sh
57-
just gettext
58-
```
30+
- Clapgrep requires up-to-date library versions (Fedora Rawhide or newest Gnome SDK)
31+
- The [`justfile`](./justfile) provides convenient commands for compilation and development.
32+
- `just ci` can be used to run the CI locally.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Clapgrep can currently search all sorts of text files, PDFs and Office documents
1616

1717
## Contributing
1818

19-
See [Contributing](/CONTRIBUTING.md).
19+
See [CONTRIBUTING.md](/CONTRIBUTING.md) for contribution and build instructions.

0 commit comments

Comments
 (0)