~tristan957/harvest-almanac

4034a506c5c282f635b945634abec0fd400a7def — Tristan Partin 1 year, 4 months ago 3e7b0d9
Get project building once again
4 files changed, 6 insertions(+), 35 deletions(-)

M .builds/alpine.yml
M .builds/fedora.yml
M CONTRIBUTING.md
M README.md
M .builds/alpine.yml => .builds/alpine.yml +1 -0
@@ 5,6 5,7 @@ packages:
  - libhandy-dev
  - libsoup-dev
  - libsecret-dev
  - json-glib-dev
  # - flatpak-builder
secrets:
  - 92357bf7-1b44-4630-999e-fca4a120c50b

M .builds/fedora.yml => .builds/fedora.yml +1 -0
@@ 5,6 5,7 @@ packages:
  - libhandy-devel
  - libsoup-devel
  - libsecret-devel
  - json-glib-devel
  # - flatpak
secrets:
  - 92357bf7-1b44-4630-999e-fca4a120c50b

M CONTRIBUTING.md => CONTRIBUTING.md +4 -28
@@ 1,15 1,5 @@
# Contributing

Harvest Almanac is composed of two components:

* `libharvest-glib`
* `harvest-almanac`

## libharvest-glib

`libharvest-glib` is an API wrapper around the Harvest API V2. It makes use of
the GObject type system around its entities.

## harvest-almanac

`harvest-almanac` is the GUI application written in GTK to interact with


@@ 28,6 18,8 @@ CC=gcc meson build

### Dependencies

You can find necessary dependecies and their versions in the root `meson.build`.

This project has been configured to use Meson's WrapDB if development libraries
are not found on the host system. If you want to use WrapDB-provided
dependencies, simply run the command


@@ 46,7 38,7 @@ Unfortunately the version of GTK in the `core18` snap is incompatible with
would take time to figure out if versions of packages in `core18` work with
GTK 3.24. This is doable if someone commits to it.

#### Host
#### Local

```text
ninja -C build


@@ 60,7 52,7 @@ flatpak-builder --verbose --sandbox --force-clean --repo=.flatpak-repo --ccache 

### Running

#### Host
#### Local

```text
./build/src/harvest-almanac


@@ 71,19 63,3 @@ flatpak-builder --verbose --sandbox --force-clean --repo=.flatpak-repo --ccache 
```text
flatpak run io.partin.tristan.HarvestAlmanac
```

### Testing

Make sure the following environment variables are set:

* `HARVEST_API_ACCESS_TOKEN`
* `HARVEST_API_CONTACT_EMAIL`
* `HARVEST_API_ACCOUNT_ID`
* `HARVEST_SOUP_MAX_CONNECTIONS`
* `HARVEST_SOUP_LOG_LEVEL`

Then run

```text
ninja test -C build
```

M README.md => README.md +0 -7
@@ 12,13 12,6 @@ This product is still largely in development, and is unusable at the moment.
Contributors are welcome to participate, however. Please refer to the
`CONTRIBUTING.md` if you are interested.

## Licensing

* `harvest-almanac` (the GUI) is licensed under the `GPL-3.0-only` license.
* `harvest-glib` (the library) is licensed under the `LGPL-3.0-only` license.

You can find each project's license in their sub-directory.

---

**Not endorsed by Harvest in any way, shape, or form**.