diff options
Diffstat (limited to '')
| -rw-r--r-- | GETTING-STARTED.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md index 2e2568e64..772637304 100644 --- a/GETTING-STARTED.md +++ b/GETTING-STARTED.md @@ -56,20 +56,20 @@ After that they should come down automatically when you pull but it's not bad to Repo Arrangement --------------------------- -The MCServer repo has recently been rearranged for better code separation and other things, but basically it's split into a few areas: +The Cuberite repo has recently been rearranged for better code separation and other things, but basically it's split into a few areas: * `src` - This holds all of the MCServer source code, and is where most development takes place. + This holds all of the Cuberite source code, and is where most development takes place. It's split into logical areas for blocks, the protocol handling and other things. * `lib` - This holds all the 3rd party libraries for MCServer. You basically don't need to touch these, and we're thinking of switching them into submodules soon. + This holds all the 3rd party libraries for Cuberite. You basically don't need to touch these, and we're thinking of switching them into submodules soon. * `MCServer` This folder isn't greatly named, but it contains the default plugins and environment to actually run the server. You'll find the executable (named `MCServer`) here and in the `plugins` subdir the default plugins. The config files are also stored here. Config files with `.example.ini` on the end are generated by the server or source control and should be left alone, instead you should copy them to a file without the `example` in the name which will be prioritised over the generated ones. Code Styles ------------------ -Mainly follow the code styles in [CONTRIBUTING.md](https://github.com/mc-server/MCServer/blob/master/CONTRIBUTING.md), which is definitely an important read. +Mainly follow the code styles in [CONTRIBUTING.md](https://github.com/cuberite/cuberite/blob/master/CONTRIBUTING.md), which is definitely an important read. Note that there is a script file, $/src/CheckBasicStyle.lua, that can check some common violations of the coding style. You should run this file to check your code regularly. This script is run during the integration builds and if it fails, the build will fail. Note that you need Lua installed in order to run this script. @@ -79,7 +79,7 @@ How to Build **Linux/BSD/Solaris/OSX:** -Follow the instructions in [COMPILING.md](https://github.com/mc-server/MCServer/blob/master/COMPILING.md). You probably want to build in debug mode (when you're developing) for console alerts and debugging capability, even though it's much slower for everyday use. +Follow the instructions in [COMPILING.md](https://github.com/cuberite/cuberite/blob/master/COMPILING.md). You probably want to build in debug mode (when you're developing) for console alerts and debugging capability, even though it's much slower for everyday use. Basically, the process is: @@ -88,7 +88,7 @@ Basically, the process is: **Windows:** You need to first generate a solution file by executing `cmake .` on the commandline at the top-level folder of the repository, then just open the solution file in MSVC and build. Note that the first time after generating the solution, you will need to do extra setup in order to be able to fully debug in MSVC: -- Set the startup project to MCServer: right-click the MCServer project in the Solution Explorer and choose "Set as Startup Project". +- Set the startup project to Cuberite: right-click the MCServer project in the Solution Explorer and choose "Set as Startup Project". - Set the debugging folder: right-click the MCServer project in the Solution Explorer, choose "Properties". In the dialog, browse to "Configuration Properties" -> "Debugging" and set "Working Directory" to "../MCServer". How to Run @@ -108,7 +108,7 @@ There are a few fairly easy issues for you to get started with, as well as some * #577 * #381 * #752 - * Clean up some of the compiler warnings. (Check [Travis CI](http://travis-ci.org/mc-server/MCServer) for a list of them.) With clang, there are over 10000 lines of warnings to clean up. + * Clean up some of the compiler warnings. (Check [Travis CI](http://travis-ci.org/cuberite/cuberite) for a list of them.) With clang, there are over 10000 lines of warnings to clean up. **More Difficult**: @@ -116,7 +116,7 @@ There are a few fairly easy issues for you to get started with, as well as some * #134 * #215 -You may also want to write some plugins. They are written in lua, with excellent API documentation available via [APIDump](http://mc-server.xoft.cz/LuaAPI). The [Core](https://github.com/mc-server/Core) plugin should also help quite a bit here. +You may also want to write some plugins. They are written in lua, with excellent API documentation available via [APIDump](http://api-docs.cuberite.org). The [Core](https://github.com/mc-server/Core) plugin should also help quite a bit here. Special Things --------------------- |