Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
- Remove no longer implemented features
- Describe installation using flatpak-builder
- Use newer meson compile/install commands
- Create History section
  • Loading branch information
ryonakano committed Mar 7, 2024
1 parent 869571c commit 856a2bf
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,23 @@ Other features include:

- Edit or delete created app entries without opening the file manager
- Automatically add execution permission to the file you select
- Syntax error detection
- Automatically save everything―your data in editing, last open view, and preferences

The original idea of the app is inspired from https://github.com/alexkdeveloper/dfc.

## Installation
### For Users
### From Flathub (Recommended)
You can download the app from Flathub, which should make this app available for all Linux distribution:

[<img src="https://flathub.org/assets/badges/flathub-badge-en.svg" width="160" alt="Download on Flathub">](https://flathub.org/apps/details/com.github.ryonakano.pinit)
[<img src="https://flathub.org/assets/badges/flathub-badge-en.svg" width="160" alt="Download on Flathub">](https://flathub.org/apps/com.github.ryonakano.pinit)

We originally targeted this app for elementary OS and also released it on Flathub after some time, but **we decided to publish the app only on Flathub since version `2.0.0`. We no longer publish new features or bug fixes to the elementary-curated version of the app.**
### From Source Code (Flatpak)
If you would like to test latest source code, clone the repository and then run the following command:

This does not mean the app no longer available on elementary OS. You can simply switch to the Flathub version of the app; please uninstall the current installation and then re-install the app from Flathub.
```
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=flathub com.github.ryonakano.pinit.yml
```

### For Developers
### From Source Code (Native)
You'll need the following dependencies to build:

* libadwaita-1-dev (>= 1.4.0)
Expand All @@ -34,17 +35,17 @@ You'll need the following dependencies to build:
* meson (>= 0.57.0)
* valac

Run `meson setup` to configure the build environment and run `ninja` to build
Run `meson setup` to configure the build environment and run `meson compile` to build:

```bash
meson setup builddir --prefix=/usr
ninja -C builddir
meson compile -C builddir
```

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

```bash
ninja install -C builddir
meson install -C builddir
com.github.ryonakano.pinit
```

Expand All @@ -59,3 +60,6 @@ Please refer to [the contribution guideline](CONTRIBUTING.md) if you would like
## Get Support

Need help in use of the app? Refer to [the discussions page](https://github.com/ryonakano/pinit/discussions) to search for existing discussions or [start a new discussion](https://github.com/ryonakano/pinit/discussions/new/choose) if none is relevant.

## History
The original idea of the app is inspired from [Desktopius by Alex K](https://github.com/alexkdeveloper/dfc).

0 comments on commit 856a2bf

Please sign in to comment.