summarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaxime Poulin2016-07-02 00:47:31 -0400
committerMaxime Poulin2016-07-02 00:47:31 -0400
commit1cc1d7b47a23ab06c7e9f7422db167527291d7d7 (patch)
tree54dff10d7df30daf5601b48920c70806759d9140
parent430f4c86f688e99e5bb410b383d94b6f4a3f910a (diff)
downloadaur-1cc1d7b47a23ab06c7e9f7422db167527291d7d7.tar.gz
Add GitHub clone for community and visibility. Also provide instructions.
-rw-r--r--LICENSE21
-rw-r--r--README57
2 files changed, 78 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 00000000000..d54f02bb148
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+T License (MIT)
+
+Copyright (c) 2016 All contributors to The Lounge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README b/README
new file mode 100644
index 00000000000..5049b4aad2e
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+# The Lounge's official ArchLinux package
+
+This is a clone of the repository [already available](https://aur.archlinux.org/packages/thelounge/) on the [AUR](https://wiki.archlinux.org/index.php/Arch_User_Repository).
+
+This repository is to be used to track ArchLinux's specific issues with this package and allow users to contribute changes to it as well.
+
+## Installation
+
+Please follow the usual ArchLinux documentation to install this package fromt he AUR either manually or using your favorite AUR helper. These instructions are only provided as a quick example, but as typical with ArchLinux you are strongly encouraged to read the approprite documentation.
+
+### Manually
+```
+$ git clone https://github.com/thelounge/arch-lounge.git
+$ cd arch-lounge
+$ # optional: select your release (experimental, master, stable)
+$ git checkout stable
+$ makepkg
+# pacman -U thelounge-*.pkg.*
+```
+
+### With an AUR helper
+with pacaur:
+```
+$ pacaur -aS thelounge
+```
+
+or with yaourt:
+```
+$ yaourt -aS thelounge
+```
+
+### Configuration
+The default system-wide documentation file is located at `/etc/thelounge/config.js`. Please note that user profiles and their IRC passwords are also stored there (moving to `/var/lib/thelounge` is planned but not yet done), so the directory is only readable by the `thelounge` user.
+
+### Running
+The Lounge provides both a system-wide and per-user systemd unit.
+
+#### System
+Simply enable the `thelounge.service` unit, and your server should be up and running:
+
+```
+# systemctl enable --now thelounge.service
+```
+
+#### User
+If you do not want to run the software system-wide, or host multiple users that wish to host their own instance of The Lounge, it can also be launched per user:
+
+```
+$ systemctl --user enable --now thelounge.service
+```
+
+Please note that for The Lounge to start on boot in this scenario, you will also require to have [lingering](https://wiki.archlinux.org/index.php/Systemd/User#Automatic_start-up_of_systemd_user_instances) enabled for this user:
+
+```
+# loginctl enable-linger $username
+```
+