aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ead098
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# picom
+A Fork of Pijulius picom published by Allusive.
+
+WE NOW HAVE A WIKI!
+[Check It Out Here](https://github.com/allusive-dev/picom-allusive/wiki)
+
+### Have An Issue? Open one and I will try to help
+
+## What it adds
+Makes the animations way smoother and more customizable than the base picom package.
+
+
+#### No Changes have been made to this package from pijulius's picom as of yet.
+
+Context: For unknown reason `picom-pijulius-git` was taken off the AUR.
+This repository is here to keep this package up-to-date and on the AUR.
+
+## Installation
+
+### Building Manually
+```
+$ meson --buildtype=release . build
+$ ninja -C build
+$ ninja -C build install
+```
+
+### Arch Linux or other Arch based distros
+```
+paru -S picom-allusive
+```
+or
+```
+yay -S picom-allusive
+```
+
+For those on Crystal Linux
+
+```
+ame -S picom-allusive
+```