CactiChameleon9/PrismLauncher
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4fe13c64a1
PrismLauncher/README.md

81 lines
4.1 KiB
Markdown
Raw Normal View History

NOISSUE update te logo in the README
2017-08-27 11:56:21 +01:00
<p align="center">
fix(readme): header color should follow GH theme As browser color scheme preference and GitHub theme can be different from each other, let's follow GitHub theme instead of browser preference.
2022-01-19 17:59:24 +00:00
<img src="./program_info/polymc-header-black.svg#gh-light-mode-only" alt="PolyMC logo"/>
<img src="./program_info/polymc-header.svg#gh-dark-mode-only" alt="PolyMC logo"/>
NOISSUE update te logo in the README
2017-08-27 11:56:21 +01:00
</p>
Update branding: New Logo (#30) New logo Co-authored-by: swirl <swurl@swurl.xyz>
2022-01-09 05:13:15 +00:00
<br>
fix readme formatting
2022-01-16 02:25:49 +00:00
Fix README and some references to MultiMC.
2021-12-13 18:01:29 +00:00
PolyMC is a custom launcher for Minecraft that focuses on predictability, long term stability and simplicity.
Remove drama from readme and remove mmc discord link
2022-02-10 11:21:25 +00:00
This is a **fork** of the MultiMC Launcher and not endorsed by MultiMC. The PolyMC community felt that the maintainer was not acting in the spirit of Free Software so this fork was made.
docs: rework README and BUILD
2022-01-27 12:46:58 +00:00
<br>
# Installation
Update and link latest build to actions
2022-03-01 13:19:30 +00:00
- All downloads and instructions for PolyMC can be found [here](https://polymc.org/download/)
- Last build status: https://github.com/PolyMC/PolyMC/actions
readd all packages
2022-02-18 09:28:17 +00:00
Add OpenBSD
2022-02-05 15:03:16 +00:00
update
2022-02-16 17:31:34 +00:00
## Development Builds
There are per-commit development builds available [here](https://github.com/PolyMC/PolyMC/actions). These have debug information in the binaries, so their file sizes are relatively larger.
Prepare readme for 1.1.0, mark unofficial packages as unofficial
2022-02-17 10:46:34 +00:00
Portable builds are provided for AppImage on Linux, Windows, and macOS.
For Debian and Arch, you can use these packages for the latest development versions:
[![polymc-git](https://img.shields.io/badge/aur-polymc--git-blue)](https://aur.archlinux.org/packages/polymc-git/)
[![polymc-git](https://img.shields.io/badge/mpr-polymc--git-orange)](https://mpr.makedeb.org/packages/polymc-git)
For flatpak, you can use [flathub-beta](https://discourse.flathub.org/t/how-to-use-flathub-beta/2111)
update
2022-02-16 17:31:34 +00:00
docs: rework README and BUILD
2022-01-27 12:46:58 +00:00
# Help & Support
NOISSUE Attempt to add build status and test teamcity build reporting
2019-11-26 23:35:42 +00:00
update README, delete RPM/Ubuntu packaging dirs Closes: #2 Update wording/information for packages add more of the individual Matrix rooms in case spaces don't work add PolyMC Discord to README Deleted RPM & Ubuntu/Debian packaging directories, will need to be moved to separate repositories.
2021-12-26 21:01:29 +00:00
Feel free to create an issue if you need help. However, you might find it easier to ask in the Discord server.
Matrix room/space, a bit more rebranding
2021-12-24 19:28:54 +00:00
update README, delete RPM/Ubuntu packaging dirs Closes: #2 Update wording/information for packages add more of the individual Matrix rooms in case spaces don't work add PolyMC Discord to README Deleted RPM & Ubuntu/Debian packaging directories, will need to be moved to separate repositories.
2021-12-26 21:01:29 +00:00
[![PolyMC Discord](https://img.shields.io/discord/923671181020766230?label=PolyMC%20Discord)](https://discord.gg/xq7fxrgtMP)
Matrix room/space, a bit more rebranding
2021-12-24 19:28:54 +00:00
Update branding: New Logo (#30) New logo Co-authored-by: swirl <swurl@swurl.xyz>
2022-01-09 05:13:15 +00:00
For people who don't want to use Discord, we have a Matrix Space which is bridged to the Discord server:
Matrix room/space, a bit more rebranding
2021-12-24 19:28:54 +00:00
update README, delete RPM/Ubuntu packaging dirs Closes: #2 Update wording/information for packages add more of the individual Matrix rooms in case spaces don't work add PolyMC Discord to README Deleted RPM & Ubuntu/Debian packaging directories, will need to be moved to separate repositories.
2021-12-26 21:01:29 +00:00
[![PolyMC Space](https://img.shields.io/matrix/polymc:polymc.org?label=PolyMC%20Space&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#polymc:polymc.org)
Matrix room/space, a bit more rebranding
2021-12-24 19:28:54 +00:00
Update branding: New Logo (#30) New logo Co-authored-by: swirl <swurl@swurl.xyz>
2022-01-09 05:13:15 +00:00
If there are any issues with the space or you are using a client that does not support the feature here are the individual rooms:
Matrix room/space, a bit more rebranding
2021-12-24 19:28:54 +00:00
update README, delete RPM/Ubuntu packaging dirs Closes: #2 Update wording/information for packages add more of the individual Matrix rooms in case spaces don't work add PolyMC Discord to README Deleted RPM & Ubuntu/Debian packaging directories, will need to be moved to separate repositories.
2021-12-26 21:01:29 +00:00
[![Support](https://img.shields.io/matrix/support:polymc.org?label=%23support&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#support:polymc.org)
[![Discussion](https://img.shields.io/matrix/discussion:polymc.org?label=%23discussion&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#discussion:polymc.org)
[![Development](https://img.shields.io/matrix/development:polymc.org?label=%23development&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#development:polymc.org)
[![News](https://img.shields.io/matrix/news:polymc.org?label=%23news&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#news:polymc.org)
docs: rework README and BUILD
2022-01-27 12:46:58 +00:00
# Development
If you want to contribute to PolyMC you might find it useful to join our Discord Server or Matrix Space.
## Building
Update README.md
2022-03-08 09:07:21 +00:00
If you want to build PolyMC yourself, check [Build Instructions](https://polymc.org/wiki/development/build-instructions/) for build instructions.
docs: rework README and BUILD
2022-01-27 12:46:58 +00:00
## Code formatting
Prepare readme for 1.1.0, mark unofficial packages as unofficial
2022-02-17 10:46:34 +00:00
docs: rework README and BUILD
2022-01-27 12:46:58 +00:00
Just follow the existing formatting.
In general, in order of importance:
- Make sure your IDE is not messing up line endings or whitespace and avoid using linters.
- Prefer readability over dogma.
- Keep to the existing formatting.
- Indent with 4 space unless it's in a submodule.
- Keep lists (of arguments, parameters, initializers...) as lists, not paragraphs. It should either read from top to bottom, or left to right. Not both.
## Translations
Fix Weblate link in README original link was missing /projects/ dir and leading to a nonexistant page
2022-02-10 03:40:57 +00:00
The translation effort for PolyMC is hosted on [Weblate](https://hosted.weblate.org/projects/polymc/polymc/) and information about translating PolyMC is available at https://github.com/PolyMC/Translations
docs: rework README and BUILD
2022-01-27 12:46:58 +00:00
Modify readme to use website
2022-03-01 00:33:59 +00:00
## Download infomation
To modify download infomation or change packaging infomation send a pull request or issue to the website [Here](https://github.com/PolyMC/polymc.github.io/blob/master/src/download.md)
docs: rework README and BUILD
2022-01-27 12:46:58 +00:00
## Forking/Redistributing/Custom builds policy
Do whatever you want, we don't care. Just follow the license. If you have any questions about this feel free to ask in an issue.
Update README.md
2022-03-08 09:07:21 +00:00
All launcher code is available under the GPL-3 license.
[Source for the website](https://github.com/PolyMC/polymc.github.io) is hosted under the AGPL-3 License.
The logo and related assets are under the CC BY-NC-SA 4.0 license.
Reference in New Issue Copy Permalink