Add README-dist.txt

@blha303, can you add this to the root of the zip file as "README.txt"
during the build?
This commit is contained in:
Drew DeVault 2015-06-18 15:43:28 -04:00
parent 561ce2dd72
commit 1a04429974
2 changed files with 43 additions and 3 deletions

42
README-dist.txt Normal file
View File

@ -0,0 +1,42 @@
You've downloaded TrueCraft, an open source implementation of Minecraft beta
1.7.3. Please note that TrueCraft is still experimental, and is likely to
include bugs and unfinished features.
=== Running TrueCraft ===
On Windows, double click `TrueCraft.Launcher.exe`. This will allow you to play
singleplayer and connect to multiplayer servers.
On Linux and OS X, run `mono TrueCraft.Launcher.exe` from a terminal.
=== Running Servers ===
You've also been given the TrueCraft server. If you want to run a server to play
with your friends, you will need to forward port 25565 on your router.
Run `TrueCraft.exe` to host a server. On Linux and OS X, you can run `mono
TrueCraft.exe` to host the server.
If you do not want to host the server yourself, try https://gamocosm.com.
=== Updating TrueCraft ===
TrueCraft is updated all the time. Download new versions from:
https://truecraft.io
Eventually TrueCraft will update itself automatically. Until then, you'll have
to update it yourself manually.
=== Community ===
You aren't the only one playing TrueCraft! Come hang out with us:
* /r/truecraft
* #truecraft on irc.esper.net
=== Source Code ===
The source code is available at https://github.com/SirCmpwn/TrueCraft
If you know how to code, you're welcome to help improve TrueCraft.

View File

@ -1,6 +1,4 @@
# TrueCraft
[![Build Status](https://travis-ci.org/SirCmpwn/TrueCraft.svg?branch=master)](https://travis-ci.org/SirCmpwn/TrueCraft)
# TrueCraft [![Build Status](https://travis-ci.org/SirCmpwn/TrueCraft.svg?branch=master)](https://travis-ci.org/SirCmpwn/TrueCraft)
http://truecraft.io - blog and such