diff --git a/README.md b/README.md index 7b227675..bf56a771 100644 --- a/README.md +++ b/README.md @@ -8,36 +8,45 @@ recommend to make a backup. If you run into an issue, please report it by creati ![Discord Shield](https://discordapp.com/api/guilds/826881530310819914/widget.png?style=shield) - -### Requirements - -- requests, -- pillow -- pyqt5 -- notify-py -- QtAwesome - ## Installation ### Installation via pip (recommend) -Execute *(sudo) pip install Rare* for all users Or *pip install Rare --user* for only one user +Execute `pip install Rare` for all users Or `pip install Rare --user` for only one user **Note**: On Linux must be /home/user/.local/bin in PATH ### Windows Simple -Download Rare.exe and place it somewhere in PATH +Download Rare.exe from the [releases page](https://github.com/Dummerle/Rare/releases) and place it somewhere in PATH **Note** Using the exe file could cause errors ### Linux -- For Arch Linux is an AUR package available: [rare-git](https://aur.archlinux.org/packages/rare-git) - or [rare](https://aur.archlinux.org/packages/rare) -- For Debian-based Distros is a .deb package at the releases -- Other distributions have to install it with pip or clone the repo and install it manually: *python3 setup.py install (--user)* +#### Arch based + +There are some AUR packages available: + - [rare](https://aur.archlinux.org/packages/rare) + - [rare-git](https://aur.archlinux.org/packages/rare-git) + +#### Debian based + +There is a `.deb` package available from the [releases page](https://github.com/Dummerle/Rare/releases): `sudo dpkg –i Rare.deb` + +#### Other + +Install via `pip`. + +## Run from source +1. Run `pip install -r requirements.txt` to get dependencies. If you use `pacman` you can run `sudo pacman --needed -S python-wheel python-setuptools python-pyqt5 python-qtawesome python-requests python-pillow` +2. For unix operating systems run `sh start.sh`. For windows run `set PYTHONPATH=%CD% && python Rare` + +## Why Rare? + +Rare uses much less RAM than electron based apps such as [HeroicGL](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher) and EpicGL which allows the games to run better. +Rare supports all major platforms (Windows, Linux, MacOS) unlike the alternatives. ## Features