yannickreiss
/
lemoa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat current state section

This commit is contained in:
Bnyro 2023-06-21 14:27:56 +02:00
parent e238beb3cf
commit 527270706f
1 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,54 +1,67 @@
# lemoa # lemoa
Native Gtk client for Lemmy (alpha state) Native Gtk client for Lemmy (alpha state)
# Current state # Current state
Under development, not yet ready for daily usage Under development, not yet ready for daily usage
Working: Working:
* Selecting lemmy instance
* Listing trending posts - Selecting lemmy instance
* Viewing a post and its comments - Listing trending posts
* Viewing profiles - Viewing a post and its comments
* Viewing trending communities - Viewing profiles
* Searching communities - Viewing trending communities
* Logging in with an account - Searching communities
* Writing posts or comments - Logging in with an account
* Viewing subscribed posts - Writing posts or comments
* Following communities - Viewing subscribed posts
* Voting for or against posts or comments - Following communities
- Voting for or against posts or comments
- Deleting posts or comments
Not yet working, but planned to be added soon: Not yet working, but planned to be added soon:
* Deleting posts or comments
* Private messages - Viewing the next pages of posts or communities
* Viewing the next pages of posts or communities - Private messages
# Build dependencies # Build dependencies
* rust
* cargo - rust
* libgtk-4-dev - cargo
- libgtk-4-dev
# Installation # Installation
```sh ```sh
cargo install --git https://github.com/lemmy-gtk/lemoa.git cargo install --git https://github.com/lemmy-gtk/lemoa.git
``` ```
You can then start the app via the terminal after adding cargo's bin directory to your PATH variable You can then start the app via the terminal after adding cargo's bin directory to your PATH variable
```sh ```sh
lemoa lemoa
``` ```
# Development # Development
Clone the repository and run Clone the repository and run
```sh ```sh
cargo run cargo run
``` ```
# Building with Docker # Building with Docker
``` ```
sudo docker build --no-cache . -t lemoa:latest sudo docker build --no-cache . -t lemoa:latest
CONTAINER_ID=$(sudo docker create --name lemoa -t lemoa:latest) CONTAINER_ID=$(sudo docker create --name lemoa -t lemoa:latest)
sudo docker cp $(CONTAINER_ID):/root/lemoa/target/release/lemoa . 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:.
# License # License
Lemoa is licensed under the [**GNU General Public License**](https://www.gnu.org/licenses/gpl.html): You can use, study and share it as you want. Lemoa is licensed under the [**GNU General Public License**](https://www.gnu.org/licenses/gpl.html): You can use, study and share it as you want.