Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Describe installation method with flatpak-builder #273

Merged
merged 1 commit into from
Apr 27, 2024
Merged

docs: Describe installation method with flatpak-builder #273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Reco
Reco is an audio recorder focused on being concise and simple to use.

You can use it to record and remember spoken words, system audio, improvized melodies, and anything else you can do with a microphone, speaker, or both.

![Welcome view in the light mode](data/screenshots/pantheon/welcome-init-light.png#gh-light-mode-only) ![Recording view in the light mode](data/screenshots/pantheon/recording-light.png#gh-light-mode-only)

![Welcome view in the dark mode](data/screenshots/pantheon/welcome-init-dark.png#gh-dark-mode-only) ![Recording view in the dark mode](data/screenshots/pantheon/recording-dark.png#gh-dark-mode-only)

Reco is an audio recorder focused on being concise and simple to use.

You can use it to record and remember spoken words, system audio, improvized melodies, and anything else you can do with a microphone, speaker, or both.

Features include:

* **Recording sounds from both your microphone and system at the same time.** This is useful for recording calls or streaming videos on the Internet.
Expand All @@ -31,13 +31,19 @@ Community packages maintained by volunteers are also available on some distribut
[![Packaging status](https://repology.org/badge/vertical-allrepos/reco.svg)](https://repology.org/project/reco/versions)

### From Source Code (Flatpak)
If you would like to test latest source code, clone the repository and then run the following command:
You'll need `flatpak` and `flatpak-builder` commands installed on your system.

Run `flatpak remote-add` to add AppCenter remote for dependencies:

```
flatpak remote-add --user --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo
flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
flatpak install -y --user flathub org.flatpak.Builder
flatpak run org.flatpak.Builder builddir-flatpak --user --install --force-clean --install-deps-from=appcenter com.github.ryonakano.reco.yml
```

To build and install, use `flatpak-builder`, then execute with `flatpak run`:

```
flatpak-builder builddir --user --install --force-clean --install-deps-from=appcenter com.github.ryonakano.reco.yml
flatpak run com.github.ryonakano.reco
```

### From Source Code (Native)
Expand All @@ -48,9 +54,7 @@ You'll need the following dependencies to build:
* libgstreamer1.0-dev (>= 1.20)
* libgtk-4-dev (>= 4.10)
* [libryokucha](https://github.com/ryonakano/ryokucha)
* automatically downloaded on build
* [livechart](https://github.com/lcallarec/live-chart) (>= 1.10.0)
* automatically downloaded on build
* meson (>= 0.57.0)
* valac

Expand All @@ -65,7 +69,7 @@ meson setup builddir --prefix=/usr
meson compile -C builddir
```

To install, use `meson install`, then execute with `com.github.ryonakano.reco`
To install, use `meson install`, then execute with `com.github.ryonakano.reco`:

```bash
meson install -C builddir
Expand Down