From d82fac114a5e9ec3361d00440cfb48f93eec323b Mon Sep 17 00:00:00 2001
From: loathingKernel <142770+loathingKernel@users.noreply.github.com>
Date: Sun, 29 Dec 2024 15:21:09 +0200
Subject: [PATCH] docs: update readmes
---
README.md | 4 ++--
docs/index.md | 23 +++++++++++++++--------
2 files changed, 17 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 77284d6ea..9551859d0 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,9 @@
Rare is a graphical interface for Legendary, a command line alternative to Epic Games launcher, written in PySide6
diff --git a/docs/index.md b/docs/index.md
index 852a4ddfb..b9d72c23b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -7,9 +7,9 @@
Rare is a graphical interface for Legendary, a command line alternative to Epic Games launcher, written in PySide6
@@ -109,15 +109,22 @@ There are some AUR packages available:
There is a `.dmg` file available in [releases page](https://github.com/RareDevs/Rare/releases).
-**Note**: When you launch it, you will see an error, that the package is from an unknown source. You have to enable it
-manually in `Settings -> Security and Privacy`. Otherwise, Gatekeeper will block Rare from running.
+Rare's macOS binaries are currently not singed and because of that when you launch Rare, you will see an error,
+that the package is from an unknown source. You have to enable it manually in `Settings -> Security and Privacy`.
+Otherwise, Gatekeeper will block Rare from running.
-You can also use `pip`.
+After installing Rare, if macOS complains that it is damaged, open a terminal and run the following command
+```shell
+sudo xattr -dr com.apple.quarantine /Applications/Rare.app
+```
+which will allow the application to run normally.
+
+Alternatively, you can install using `pip`/`pipx` or from source.
### Latest development version
-In the [actions](https://github.com/RareDevs/Rare/actions) tab you can find packages for the latest commits.
+In the [actions](https://github.com/RareDevs/Rare/actions/workflows/snapshot.yml) tab you can find packages for the latest commits.
**Note**: They might be unstable and likely broken.
@@ -154,10 +161,10 @@ environment's `PATH`
```
* If you are on Arch you can run
```lang-default
- sudo pacman --needed -S python-wheel python-setuptools python-pyqt5 python-qtawesome python-requests python-orjson
+ sudo pacman --needed -S python-wheel python-setuptools python-setuptools-scm python-pyside6 python-qtawesome python-requests python-orjson
```
```
- yay -S legendary
+ yay -S legendary python-vdf
```
* If you are on FreeBSD you have to install py39-qt5 from the packages
```lang-default