summarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAlfredo Palhares2018-04-18 17:26:44 +0100
committerAlfredo Palhares2018-04-18 17:32:35 +0100
commit7851388062fb15170919f87e0cf48a2548245b6c (patch)
tree9cec9ec85a9e0873776f378e05a3d180534d74cc /README.md
downloadaur-7851388062fb15170919f87e0cf48a2548245b6c.tar.gz
Initial Commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..ecda28d7fa1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Joplin - Arch Linux
+
+## Overview
+
+This contains the `PKGBUILD` and other build tools to package
+[Joplin](https://joplin.cozic.net/)
+
+This package contains both the desktop and cli client
+
+## Installing
+
+You can use an AUR wrapper like [yay](https://aur.archlinux.org/packages/yay/)
+
+## Building
+
+Build with makepkg
+
+```
+makepkg -fc
+```
+
+Check more information on the [Archwiki](https://wiki.archlinux.org/index.php/Makepkg)
+
+## Contributing
+
+Please Open a Pull Request or an Issue :)
+
+## Maintainer
+
+ [Alfredo Palhares](https://github.com/masterkorp)
+