README.md 2.74 KB
Newer Older
1
# Health
2
3
4
5
<p float="left">
<a href="https://flathub.org/apps/details/dev.Cogitri.Health"><img height='80' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
<a href="https://circle.gnome.org/"><img height='80' alt='Part of GNOME Circle' src='https://gitlab.gnome.org/Teams/Circle/-/raw/91de93edbb3e75eb0882d56bd466e58b525135d5/assets/button/circle-button-fullcolor.svg'/>
</p>
Rasmus Thomsen's avatar
Rasmus Thomsen committed
6
7
8

A health tracking app for the GNOME desktop.

Rasmus Thomsen's avatar
Rasmus Thomsen committed
9
![screenshot](https://gitlab.gnome.org/World/Health/raw/master/docs/screenshot_main.png)
Rasmus Thomsen's avatar
Rasmus Thomsen committed
10

11
## Hacking on Health
Rasmus Thomsen's avatar
Rasmus Thomsen committed
12

13
14
### With GNOME Builder

Yağızhan Burak Yakar's avatar
Yağızhan Burak Yakar committed
15
Open GNOME Builder, click on `Clone Repository...` and enter the repository URL. Afterwards, click on `Clone Project` and you should be all set up. Pressing `F5` or pressing the build button in the top bar should build Health for you.<>
16

17
### Building in Flatpak
Rasmus Thomsen's avatar
Rasmus Thomsen committed
18
19
20
21

You can build Health with the following command:

```sh
22
flatpak-builder --user --install --force-clean app dev.Cogitri.Health.json
Rasmus Thomsen's avatar
Rasmus Thomsen committed
23
24
```

25
26
You can also pass `--system` instead of `--user` to flatpak-builder to install Health system-wide instead of only for your user. However, that requires root permissions.

Yağızhan Burak Yakar's avatar
Yağızhan Burak Yakar committed
27
Afterwards, you can run it with:
Rasmus Thomsen's avatar
Rasmus Thomsen committed
28
29

```sh
30
flatpak run dev.Cogitri.Health
Rasmus Thomsen's avatar
Rasmus Thomsen committed
31
32
```

Yağızhan Burak Yakar's avatar
Yağızhan Burak Yakar committed
33
For development purposes you can also run Health directly via flatpak-builder to avoid the time cost of packing the flatpak and then installing it like so:
Rasmus Thomsen's avatar
Rasmus Thomsen committed
34
35

```sh
36
37
flatpak-builder --user --force-clean app dev.Cogitri.Health.json
flatpak-builder --run app dev.Cogitri.Health.json dev.Cogitri.Health
Rasmus Thomsen's avatar
Rasmus Thomsen committed
38
```
39

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

### Building manually

If you don't want to use Flatpak, you can build Health manually like so after installing `rust`, `tracker3-devel` and `libadwaita-devel`:

```
meson -Dprofile=development build
ninja -C build
```

Afterwards, you may launch Health by running:

```
ninja -C build run
```


57
58
## Using CI Snapshots

Yağızhan Burak Yakar's avatar
Yağızhan Burak Yakar committed
59
It's possible to use the flatpak bundles that are built-in merge requests and branches of the Health repository. This allows for quick testing of changes without having to build Health yourself.
60

Yağızhan Burak Yakar's avatar
Yağızhan Burak Yakar committed
61
To download the flatpak bundle of merge requests, go to the merge request, click on "View exposed artifact" and afterwards on "Get Flatpak bundle here":
62

63
![screenshot](https://gitlab.gnome.org/World/Health/raw/master/docs/ci-mr-flatpak-bundle.png)
64
65
66
67

After downloading the file, you can install it with:

```sh
Yağızhan Burak Yakar's avatar
Yağızhan Burak Yakar committed
68
# The GNOME Nightly SDK is required for development snapshots of Health
69
70
71
72
73
74
75
76
flatpak remote-add --user --if-not-exists gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo

tar xf repo.tar
flatpak build-bundle repo/ health.flatpak dev.Cogitri.Health.Devel
flatpak install --user health.flatpak
```

As mentioned above, you can use `--system` instead of `--user` in the first&last command to install Health system-wide.