Update README.md

This commit is contained in:
Kuroppoi 2022-01-14 04:53:58 +01:00 committed by GitHub
parent d26b22aaa2
commit c84516e904
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,4 +1,5 @@
# Brainwine
[![build](https://github.com/kuroppoi/brainwine/actions/workflows/gradle.yml/badge.svg)](https://github.com/kuroppoi/brainwine/actions)
Brainwine is a Deepworld private server written in Java, made with user-friendliness and portability in mind.
Due to the time it will take for this project to be complete (and my inconsistent working on it), brainwine has been prematurely open-sourced
@ -23,8 +24,7 @@ You may download an installation package for your desired platform [here.](https
To set up the server, clone or download this repository and run `gradlew build`.\
After the build process has finished, a distribution archive should have generated in `build/distributions`.\
To start the server, simply extract this archive wherever you want and run the startup script for your OS.\
If for whatever reason you can not create a build yourself, you may download one [here.](https://github.com/kuroppoi/brainwine/releases)
To start the server, simply extract this archive wherever you want and run the startup script for your OS.
#### Configurations
@ -42,4 +42,4 @@ And, apologies in advance for the lack of documentation. Haven't gotten around t
## Issues
Found a bug? Before posting an issue, make sure your build is up-to-date and your issue has not already been posted before.
Provide a detailed explanation of the issue, and how to reproduce it. I'll get to it ASAP!
Provide a detailed explanation of the issue, and how to reproduce it. I'll get to it ASAP!