Update Readme, Screenshots, Contributing.md
|
@ -4,10 +4,12 @@
|
|||
|
||||
### Add translations
|
||||
|
||||
1. Execute ```pylupdate5 $(find -name "*.py") -ts Rare/languages/{your lang (two letters)}.ts``` in project directory
|
||||
1. Execute ```pylupdate5 $(find -name "*.py") -ts Rare/languages/de.ts``` in source directory. Replace *de* with your language code
|
||||
2. Modify the .ts file manually or in Qt Linguist
|
||||
3. Compile the file with ```lrelease Rare/languages/{lang}.ts```
|
||||
|
||||
If compilation fails, just push ts file. Then I will compile it
|
||||
|
||||
### Add Stylesheets
|
||||
|
||||
For this you can create a .qss file in Rare/Styles/ directory or modify the existing RareStyle.qss file. Here are some
|
||||
|
@ -16,11 +18,11 @@ examples:
|
|||
|
||||
### Add features
|
||||
|
||||
Select one Card of the project and implement it or make other changes
|
||||
Select one Card of the project and implement it, or if you want to add another feature ask me on Discord, or create an issue on GitHub
|
||||
|
||||
|
||||
## Git crash-course
|
||||
To contribute fork the repository and clone **your** repo. Then make your changes, add it to git with `git add File.xy` and upload it to GitHub with `git commit -m "message"` and `git push`.
|
||||
Some IDEs can do this automatically.
|
||||
|
||||
If you uploaded your changes, create a pull request to dev-branch
|
||||
If you uploaded your changes, create a pull request
|
||||
|
|
10
README.md
|
@ -21,7 +21,7 @@ Execute `pip install Rare` for all users Or `pip install Rare --user` for only o
|
|||
Download Rare.exe from the [releases page](https://github.com/Dummerle/Rare/releases) and execute it.
|
||||
|
||||
**Note:**
|
||||
Using the exe file could cause errors with Windows Defender or other Anti Virus
|
||||
Using the exe file could cause errors with Windows Defender or other Anti Virus. Sometimes it is not possible to download games and sometimes the app crashes. In this case please use pip
|
||||
|
||||
### Linux
|
||||
|
||||
|
@ -30,7 +30,6 @@ Using the exe file could cause errors with Windows Defender or other Anti Virus
|
|||
There are some AUR packages available:
|
||||
- [rare](https://aur.archlinux.org/packages/rare) - for stable releases
|
||||
- [rare-git](https://aur.archlinux.org/packages/rare-git) - for the latest features, which are not in a stable release
|
||||
- [rare-dev](https://aur.archlinux.org/packages/rare-dev) - dev branch: latest development features. This could be unstable
|
||||
|
||||
#### Debian based
|
||||
|
||||
|
@ -47,7 +46,7 @@ Install via `pip`.
|
|||
## 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.
|
||||
- Rare supports all major platforms (Windows, Linux, macOS) unlike the alternatives.
|
||||
|
||||
## Features
|
||||
|
||||
|
@ -59,7 +58,6 @@ Install via `pip`.
|
|||
- Translations (English, German and French)
|
||||
|
||||
## Planned Features
|
||||
- Offline mode
|
||||
- More Translations (Need help)
|
||||
- More Information about Games
|
||||
More planned features are in projects
|
||||
|
@ -70,8 +68,6 @@ There are more options to contribute.
|
|||
- If you are a designer, you can add Stylesheets or create a logo or a banner
|
||||
- You can translate the application in your language
|
||||
|
||||
**Note:** Pull Requests please to "dev" branch
|
||||
|
||||
More Information is in CONTRIBUTING.md
|
||||
|
||||
## Images
|
||||
|
@ -79,4 +75,4 @@ More Information is in CONTRIBUTING.md
|
|||
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/Rare.png?raw=true)
|
||||
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/GameInfo.png?raw=true)
|
||||
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/RareSettings.png?raw=true)
|
||||
|
||||
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/RareDownloads.png?raw=true)
|
||||
|
|
Before Width: | Height: | Size: 158 KiB After Width: | Height: | Size: 148 KiB |
Before Width: | Height: | Size: 695 KiB After Width: | Height: | Size: 660 KiB |
BIN
Screenshots/RareDownloads.png
Normal file
After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 64 KiB |