flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Updated the README (#4060)

Browse Source 
* Add a curl command for the complie.sh script
* Improve status shields
* Comply with the commonmark spec
This commit is contained in:
Bond-009 2017-10-21 18:52:19 +02:00 committed by Alexander Harkness
parent 05e7be7f73
commit f657193f45
1 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,6 +1,8 @@
Cuberite [![Build Status](https://img.shields.io/travis/cuberite/cuberite/master.svg?style=flat)](https://travis-ci.org/cuberite/cuberite) [![Circle CI Build Status](https://circleci.com/gh/cuberite/cuberite.svg?&style=shield
)](https://circleci.com/gh/cuberite/cuberite) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/cuberite/cuberite?svg=true)](https://ci.appveyor.com/project/madmaxoft/mcserver)
========
# Cuberite
[![Build Status](https://img.shields.io/travis/cuberite/cuberite/master.svg?label=Travis)](https://travis-ci.org/cuberite/cuberite)
[![Circle CI Build Status](https://img.shields.io/circleci/project/github/cuberite/cuberite/master.svg?label=Circle)](https://circleci.com/gh/cuberite/cuberite)
[![AppVeyor Build Status](https://img.shields.io/appveyor/ci/madmaxoft/mcserver/master.svg?label=AppVeyor)](https://ci.appveyor.com/project/madmaxoft/mcserver)
Cuberite is a Minecraft-compatible multiplayer game server that is written in C++ and designed to be efficient with memory and CPU, as well as having a flexible Lua Plugin API. Cuberite is compatible with the vanilla Minecraft client.
@ -10,8 +12,7 @@ We currently support Release 1.8 - 1.12.2 Minecraft protocol versions.
Subscribe to [the newsletter][1] for important updates and project news.
Installation
------------
## Installation
There are several ways to obtain Cuberite.
@ -38,14 +39,19 @@ Compiling may provide better performance (1.5-3x as fast) and it supports more o
This script downloads the source code and compiles it. The script is smart enough to notify you of missing dependencies and instructing you on how to install them. The script doesn't work for Windows.
Using curl:
sh -c "$(curl -sSfL -o - https://compile.cuberite.org)"
Or using wget:
sh -c "$(wget -O - https://compile.cuberite.org)"
### Hosted services
- Hosted Cuberite is available via [Gamocosm][5].
Contributing
------------
## Contributing
Cuberite is licensed under the Apache License V2, and we welcome anybody to fork and submit a Pull Request back with their changes, and if you want to join as a permanent member we can add you to the team.
@ -57,8 +63,7 @@ If you are not a programmer, you can help by testing Cuberite and reporting bugs
You can also help with documentation by contributing to the [User's Manual][12].
Other Stuff
-----------
## Other Stuff
For other stuff, check out the [homepage][13], the [Users' Manual][14], the [forums][15], and the [Plugin API][16].