From f4036ed655272ee12b5136a1ec6af19db4b5131c Mon Sep 17 00:00:00 2001 From: Bnyro Date: Wed, 28 Jun 2023 21:16:05 +0200 Subject: [PATCH] Reorganize Readme and add flathub link --- Dockerfile | 2 +- README.md | 60 ++++++++++--------- data/io.github.lemmygtk.lemoa.metainfo.xml.in | 10 ++-- 3 files changed, 39 insertions(+), 33 deletions(-) diff --git a/Dockerfile b/Dockerfile index 720a21d..1eeb8fb 100644 --- a/Dockerfile +++ b/Dockerfile @@ -13,7 +13,7 @@ RUN xbps-install -Syu && \ xbps-install -y git WORKDIR /root -RUN git clone https://github.com/lemmy-gtk/lemoa +RUN git clone https://github.com/lemmygtk/lemoa RUN cd lemoa && \ cargo build --release diff --git a/README.md b/README.md index 7484b19..6456c1c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # lemoa -Native Gtk client for Lemmy (beta state) +Native Gtk client for Lemmy (beta) -# Current state +## Installation -Working: +| Platform | Command | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Flathub | | + +If you don't use any of these platforms, consider [building the app from source](#Building). + +# Features -- Selecting lemmy instance - Listing trending posts - Viewing a post and its comments - Viewing profiles @@ -25,29 +30,20 @@ Working: - rust - cargo -- libgtk-4-dev +- pkg-config +- libgtk-4-dev or gtk4-devel (name depends on the distro) -# Installation +# Building -```sh -cargo install --git https://github.com/lemmy-gtk/lemoa.git +## Building with meson + +``` +meson _build +ninja -C _build +sudo ninja -C _build install ``` -You can then start the app via the terminal after adding cargo's bin directory to your PATH variable - -```sh -lemoa -``` - -# Development - -Clone the repository and run - -```sh -cargo run -``` - -# Building with Docker +## Building with Docker ``` sudo docker build --no-cache . -t lemoa:latest @@ -57,12 +53,22 @@ sudo docker cp $(CONTAINER_ID):/root/lemoa/target/release/lemoa . Once the build is done, there will be an executable `lemoa` binary file in your current directory, executing it starts Lemoa :tada:. -# Building with meson +## Building the binary only +Not recommended: To only install the binary (can only be started with the terminal), run + +```sh +cargo install --git https://github.com/lemmygtk/lemoa.git ``` -meson _build -ninja -C _build -sudo ninja -C _build install + +You can then start the app via the terminal after adding cargo's bin directory to your PATH variable. + +# Development + +Clone the repository and run + +```sh +cargo run ``` # License diff --git a/data/io.github.lemmygtk.lemoa.metainfo.xml.in b/data/io.github.lemmygtk.lemoa.metainfo.xml.in index 7ef1781..cd9e482 100644 --- a/data/io.github.lemmygtk.lemoa.metainfo.xml.in +++ b/data/io.github.lemmygtk.lemoa.metainfo.xml.in @@ -10,20 +10,20 @@ - https://raw.githubusercontent.com/lemmy-gtk/lemoa/main/data/screenshots/posts.png + https://raw.githubusercontent.com/lemmygtk/lemoa/main/data/screenshots/posts.png Posts view - https://raw.githubusercontent.com/lemmy-gtk/lemoa/main/data/screenshots/community.png + https://raw.githubusercontent.com/lemmygtk/lemoa/main/data/screenshots/community.png Community - https://raw.githubusercontent.com/lemmy-gtk/lemoa/main/data/screenshots/user.png + https://raw.githubusercontent.com/lemmygtk/lemoa/main/data/screenshots/user.png User profile - https://github.com/lemmy-gtk/lemoa - https://github.com/lemmy-gtk/lemoa/issues + https://github.com/lemmygtk/lemoa + https://github.com/lemmygtk/lemoa/issues