Merge pull request #214 from PolyMC/ZekeSmith-newReadme
Modify readme to use website
This commit is contained in:
timoreo22
GitHub
commit
9020f632b2
111
README.md
111
README.md
@ -11,113 +11,9 @@ This is a **fork** of the MultiMC Launcher and not endorsed by MultiMC. The Poly
|
|||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
- All packages (archived by version) can be found [here](https://packages.polymc.org/) ([latest](https://packages.polymc.org/latest))
|
- All downloads and instructions for PolyMC can be found [here](https://polymc.org/download/)
|
||||||
- Last build status: https://jenkins.polymc.org/job/PolyMC/lastBuild/
|
- Last build status: https://github.com/PolyMC/PolyMC/actions
|
||||||
|
|
||||||
## 🐧 Linux
|
|
||||||
|
|
||||||
### <img src="https://www.vectorlogo.zone/logos/linuxfoundation/linuxfoundation-icon.svg" height="20" alt=""/> Cross-distro packages
|
|
||||||
|
|
||||||
<a href='https://flathub.org/apps/details/org.polymc.PolyMC'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
|
|
||||||
|
|
||||||
<a href="https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage"><img src="https://docs.appimage.org/_images/download-appimage-banner.svg" width="240" alt="Download as AppImage" /></a>
|
|
||||||
|
|
||||||
- [AppImage SHA256](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage.sha256)
|
|
||||||
|
|
||||||
### <img src="https://www.vectorlogo.zone/logos/archlinux/archlinux-icon.svg" height="20"/> Arch Linux
|
|
||||||
|
|
||||||
There are several AUR packages available:
|
|
||||||
|
|
||||||
[](https://aur.archlinux.org/packages/polymc/)
|
|
||||||
[](https://aur.archlinux.org/packages/polymc-bin/)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# source package:
|
|
||||||
yay -S polymc
|
|
||||||
# binary package:
|
|
||||||
yay -S polymc-bin
|
|
||||||
```
|
|
||||||
|
|
||||||
### <img src="https://www.vectorlogo.zone/logos/debian/debian-icon.svg" height="20" /> Debian and <img src="https://www.vectorlogo.zone/logos/ubuntu/ubuntu-icon.svg" height="20" /> Ubuntu
|
|
||||||
|
|
||||||
We use [makedeb](https://docs.makedeb.org/) for our Debian packages.
|
|
||||||
Several MPR packages are available:
|
|
||||||
|
|
||||||
[](https://mpr.makedeb.org/packages/polymc)
|
|
||||||
[](https://mpr.makedeb.org/packages/polymc-bin)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# source package:
|
|
||||||
sudo tap install polymc
|
|
||||||
# binary package:
|
|
||||||
sudo tap install polymc-bin
|
|
||||||
```
|
|
||||||
|
|
||||||
### <img src="https://www.vectorlogo.zone/logos/nixos/nixos-icon.svg" height="20" /> Nix
|
|
||||||
|
|
||||||
A [Nix derivation](packages/nix/NIX.md) is available.
|
|
||||||
|
|
||||||
### <img src="https://www.gentoo.org/assets/img/logo/gentoo-signet.svg" height="20" /> Gentoo
|
|
||||||
|
|
||||||
A Gentoo ebuild is available in the [swirl](https://git.swurl.xyz/swirl/ebuilds) overlay, named `games-action/polymc`.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# as root:
|
|
||||||
emerge --oneshot eselect-repository
|
|
||||||
eselect repository enable swirl
|
|
||||||
emaint sync -r swirl
|
|
||||||
emerge polymc
|
|
||||||
# to use latest git version:
|
|
||||||
sudo tee -a /etc/portage/package.accept_keywords <<< "=games-action/polymc-9999 **"
|
|
||||||
```
|
|
||||||
|
|
||||||
### <img src="https://www.vectorlogo.zone/logos/getfedora/getfedora-icon.svg" height="20"> Fedora
|
|
||||||
|
|
||||||
An RPM package is available on [COPR](https://copr.fedorainfracloud.org/coprs/polymc/polymc/).
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo dnf copr enable polymc/polymc
|
|
||||||
sudo dnf install polymc
|
|
||||||
```
|
|
||||||
|
|
||||||
### <img src="https://lotar.altervista.org/wiki/_media/news/slackware-logo.png" height="20" /> Slackware
|
|
||||||
|
|
||||||
[A SlackBuild](https://codeberg.org/glowiak/SlackBuilds/src/branch/master/repository/polymc.md) is available. You will need [qt5](http://slackbuilds.org/repository/14.2/libraries/qt5/) (on 15.0 installed by default), [a JDK](https://codeberg.org/glowiak/SlackBuilds/src/branch/master/repository/adoptium-jdk8.md), and if you're on 14.2, you need to compile newer CMake version manually. To build, type in extracted directory with all dependiences met:
|
|
||||||
|
|
||||||
sudo ./polymc.SlackBuild
|
|
||||||
sudo installpkg /tmp/polymc-version-arch-1_SBo.tgz
|
|
||||||
|
|
||||||
You can also download a community-maintained [prebuilt x86_64 package](http://glowiak.github.io/file/polymc-latest-slackware) and install it with /sbin/installpkg:
|
|
||||||
|
|
||||||
sudo /sbin/installpkg ~/Downloads/polymc-version-x86_64-1_SBo.tgz
|
|
||||||
|
|
||||||
## <img src="https://www.vectorlogo.zone/logos/microsoft/microsoft-icon.svg" height="20" /> Windows
|
|
||||||
|
|
||||||
[Windows (32-bit)](https://packages.polymc.org/latest/win32/win32.zip) ([SHA256](https://packages.polymc.org/latest/win32/win32.zip.sha256)) - this is a portable package, you can extract it anywhere and run it. This package needs testing.
|
|
||||||
|
|
||||||
## <img src="https://www.vectorlogo.zone/logos/apple/apple-tile.svg" height="20" /> MacOS
|
|
||||||
|
|
||||||
MacOS has experimental development builds available [here](https://github.com/PolyMC/PolyMC/actions)
|
|
||||||
|
|
||||||
## <img src="https://www.vectorlogo.zone/logos/freebsd/freebsd-icon.svg" height="20" /> FreeBSD
|
|
||||||
|
|
||||||
There are community-maintained binary packages available:
|
|
||||||
|
|
||||||
- [AppBSD Image](http://glowiak.github.io/file/polymc-latest-fbsd64-appbsd) - a portable application, requires [AppBSD](https://codeberg.org/glowiak/appbsd/) (0.4.9 or newer) to be installed.
|
|
||||||
|
|
||||||
- [Gzipped binaries](http://glowiak.github.io/file/polymc-latest-fbsd64-raw) - traditional way to distribute, unpack and run.
|
|
||||||
|
|
||||||
In both cases you need X11, Qt5 and Java installed. Both files are 64bit only.
|
|
||||||
You can build from source - see [BUILD.md](./BUILD.md)
|
|
||||||
|
|
||||||
## <img src="https://raw.githubusercontent.com/AliasIO/wappalyzer/master/src/drivers/webextension/images/icons/OpenBSD%20httpd.svg" height="20" /> OpenBSD
|
|
||||||
|
|
||||||
There are community-maintained binary packages available:
|
|
||||||
|
|
||||||
- [gzipped 32-bit binaries](http://glowiak.github.io/file/polymc-latest-obsd32-raw), download, unpack and run.
|
|
||||||
|
|
||||||
You need X11, Qt5 and Java installed.
|
|
||||||
You can build from source - see [BUILD.md](./BUILD.md)
|
|
||||||
|
|
||||||
## Development Builds
|
## Development Builds
|
||||||
|
|
||||||
@ -170,6 +66,9 @@ In general, in order of importance:
|
|||||||
|
|
||||||
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
|
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
|
||||||
|
|
||||||
|
## 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)
|
||||||
|
|
||||||
## Forking/Redistributing/Custom builds policy
|
## 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.
|
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.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user