From 51c919ea2a0ff10ccb84b205a32b5649f497d685 Mon Sep 17 00:00:00 2001
From: Bnyro <82752168+Bnyro@users.noreply.github.com>
Date: Sun, 18 Jun 2023 17:09:50 +0200
Subject: [PATCH] Add project info and build instructions

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f6310f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# lemoa
+Native Gtk client for Lemmy (alpha state)
+
+# Current state
+Under development, not yet ready for daily usage
+Working:
+* Selecting lemmy instance
+* Listing trending posts
+* Viewing a post and its comments
+* Viewing profiles
+* Viewing trending communities
+* Searching communities
+
+Not yet working:
+* Logging in
+* Writing posts or comments
+* Insteracting with posts or comments
+* Private messages
+* Viewing the next pages of posts or communities
+
+# Build dependencies
+* rust
+* cargo
+* libgtk-4-dev
+
+# Installation
+```sh
+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
+```sh
+lemoa
+```
+
+# Development
+Clone the repository and run
+```sh
+cargo run
+```
+
+# 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.