1
0
Fork 0
mirror of synced 2024-06-17 01:54:46 +12:00

Merge pull request #350 from loathingKernel/next

Update readme
This commit is contained in:
Stelios Tsampas 2023-12-20 12:26:00 +02:00 committed by GitHub
commit a2baa3a978
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -23,15 +23,18 @@ Rare is a graphical interface for Legendary, a command line alternative to Epic
- Packages, packages everywhere - Packages, packages everywhere
## Issues ## Reporing issues
If you run into any issues, please report it by creating an issue on GitHub or on Discord: https://discord.gg/YvmABK9YSk If you run into any issues, you can report them by creating an issue on GitHub: https://github.com/RareDevs/Rare/issues/new/choose
When reporting issues, it is helpful to also include the logs with your issue. When reporting issues, it is helpful to also include the logs with your issue.
You can find the longs in the following locations depending on your operating system You can find the longs in the following locations depending on your operating system
- Windows: `C:\Users\<username>\AppData\Local\Rare\Rare\cache\logs`
- Linux: `~/.cache/Rare/Rare/logs` | OS | Path |
- masOS: `/Users/<username>/Library/Caches/Rare/Rare/logs` |---------|----------------------------------------------------------|
| Windows | `C:\Users\<username>\AppData\Local\Rare\Rare\cache\logs` |
| Linux | `/home/<username>/.cache/Rare/Rare/logs` |
| masOS | `/Users/<username>/Library/Caches/Rare/Rare/logs` |
In these folders you will find files named like below In these folders you will find files named like below
@ -42,12 +45,13 @@ These are the logs for the main Rare application. As such are importand when Rar
- `RareLauncher_f4e0c1dff48749fa9145c1585699e276_23-12-17--19-53.log` - `RareLauncher_f4e0c1dff48749fa9145c1585699e276_23-12-17--19-53.log`
These are the logs for each of the games you run through Rare. Rare uses a separate instance of itself These are the logs for each of the games you run through Rare. Rare uses a separate instance of itself
to launch games, and this is the logs of that instance. to launch games, and these are the logs of that instance.
If you don't have a GitHub account or you just want to chat, you also can contact us on Discord: https://discord.gg/YvmABK9YSk
## Installation ## Installation
### Linux ### Linux
#### Flatpak #### Flatpak
@ -132,10 +136,13 @@ Execute `pip install Rare` for all users, or `pip install Rare --user` for the c
It is possible to create a desktop link, or a start menu link. Execute the command above with `--desktop-shortcut` or `--startmenu-shortcut` option, alternatively you can create them in the settings. It is possible to create a desktop link, or a start menu link. Execute the command above with `--desktop-shortcut` or `--startmenu-shortcut` option, alternatively you can create them in the settings.
**Note about $PATH**: **Note about $PATH**:
Depending on your operating system and the `python` distribution, the following paths might need to be in your environment's `PATH`
* On Linux `/home/user/.local/bin` must be in your PATH. | OS | Path |
* On Windows `PythonInstallationDirectory\Scripts` must be in your PATH. |---------|--------------------------------------------|
* On macOS `/Users/user/Library/Python/3.x/bin` must be in your PATH. | Windows | `<python_installation_folder>\Scripts` |
| Linux | `/home/<username>/.local/bin` |
| masOS | `/Users/<username>/Library/Python/3.x/bin` |
### Run from source ### Run from source