Reorganize Readme and add flathub link
This commit is contained in:
parent
dcdcf1b0a1
commit
f4036ed655
|
@ -13,7 +13,7 @@ RUN xbps-install -Syu && \
|
||||||
xbps-install -y git
|
xbps-install -y git
|
||||||
|
|
||||||
WORKDIR /root
|
WORKDIR /root
|
||||||
RUN git clone https://github.com/lemmy-gtk/lemoa
|
RUN git clone https://github.com/lemmygtk/lemoa
|
||||||
RUN cd lemoa && \
|
RUN cd lemoa && \
|
||||||
cargo build --release
|
cargo build --release
|
||||||
|
|
||||||
|
|
60
README.md
60
README.md
|
@ -1,12 +1,17 @@
|
||||||
# lemoa
|
# lemoa
|
||||||
|
|
||||||
Native Gtk client for Lemmy (beta state)
|
Native Gtk client for Lemmy (beta)
|
||||||
|
|
||||||
# Current state
|
## Installation
|
||||||
|
|
||||||
Working:
|
| Platform | Command |
|
||||||
|
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Flathub | <a href="https://flathub.org/apps/details/io.github.lemmygtk.lemoa"><img src="https://flathub.org/assets/badges/flathub-badge-en.png" width="150"/></a> |
|
||||||
|
|
||||||
|
If you don't use any of these platforms, consider [building the app from source](#Building).
|
||||||
|
|
||||||
|
# Features
|
||||||
|
|
||||||
- Selecting lemmy instance
|
|
||||||
- Listing trending posts
|
- Listing trending posts
|
||||||
- Viewing a post and its comments
|
- Viewing a post and its comments
|
||||||
- Viewing profiles
|
- Viewing profiles
|
||||||
|
@ -25,29 +30,20 @@ Working:
|
||||||
|
|
||||||
- rust
|
- rust
|
||||||
- cargo
|
- cargo
|
||||||
- libgtk-4-dev
|
- pkg-config
|
||||||
|
- libgtk-4-dev or gtk4-devel (name depends on the distro)
|
||||||
|
|
||||||
# Installation
|
# Building
|
||||||
|
|
||||||
```sh
|
## Building with meson
|
||||||
cargo install --git https://github.com/lemmy-gtk/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
|
## Building with Docker
|
||||||
|
|
||||||
```sh
|
|
||||||
lemoa
|
|
||||||
```
|
|
||||||
|
|
||||||
# Development
|
|
||||||
|
|
||||||
Clone the repository and run
|
|
||||||
|
|
||||||
```sh
|
|
||||||
cargo run
|
|
||||||
```
|
|
||||||
|
|
||||||
# Building with Docker
|
|
||||||
|
|
||||||
```
|
```
|
||||||
sudo docker build --no-cache . -t lemoa:latest
|
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:.
|
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
|
You can then start the app via the terminal after adding cargo's bin directory to your PATH variable.
|
||||||
sudo ninja -C _build install
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
Clone the repository and run
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo run
|
||||||
```
|
```
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
|
@ -10,20 +10,20 @@
|
||||||
</description>
|
</description>
|
||||||
<screenshots>
|
<screenshots>
|
||||||
<screenshot type="default">
|
<screenshot type="default">
|
||||||
<image>https://raw.githubusercontent.com/lemmy-gtk/lemoa/main/data/screenshots/posts.png</image>
|
<image>https://raw.githubusercontent.com/lemmygtk/lemoa/main/data/screenshots/posts.png</image>
|
||||||
<caption>Posts view</caption>
|
<caption>Posts view</caption>
|
||||||
</screenshot>
|
</screenshot>
|
||||||
<screenshot>
|
<screenshot>
|
||||||
<image>https://raw.githubusercontent.com/lemmy-gtk/lemoa/main/data/screenshots/community.png</image>
|
<image>https://raw.githubusercontent.com/lemmygtk/lemoa/main/data/screenshots/community.png</image>
|
||||||
<caption>Community</caption>
|
<caption>Community</caption>
|
||||||
</screenshot>
|
</screenshot>
|
||||||
<screenshot>
|
<screenshot>
|
||||||
<image>https://raw.githubusercontent.com/lemmy-gtk/lemoa/main/data/screenshots/user.png</image>
|
<image>https://raw.githubusercontent.com/lemmygtk/lemoa/main/data/screenshots/user.png</image>
|
||||||
<caption>User profile</caption>
|
<caption>User profile</caption>
|
||||||
</screenshot>
|
</screenshot>
|
||||||
</screenshots>
|
</screenshots>
|
||||||
<url type="homepage">https://github.com/lemmy-gtk/lemoa</url>
|
<url type="homepage">https://github.com/lemmygtk/lemoa</url>
|
||||||
<url type="bugtracker">https://github.com/lemmy-gtk/lemoa/issues</url>
|
<url type="bugtracker">https://github.com/lemmygtk/lemoa/issues</url>
|
||||||
<content_rating type="oars-1.0" />
|
<content_rating type="oars-1.0" />
|
||||||
<releases>
|
<releases>
|
||||||
<release version="0.1.0" date="2023-06-26">
|
<release version="0.1.0" date="2023-06-26">
|
||||||
|
|
Loading…
Reference in New Issue