Permalink
Browse files

Updates readme.md

Updates the links, fixes small spelling and grammar errors, and removes the small outdated "Polymorph Era" bit.
  • Loading branch information...
1 parent 44ecfa7 commit 9992825f2afa6aef477f7b316fc8d41dc2708e93 @ike709 ike709 committed Aug 2, 2014
Showing with 14 additions and 20 deletions.
  1. +14 −20 README.md
View
@@ -1,37 +1,37 @@
NTStation 13 - March 2014 [![Build Status](https://travis-ci.org/NTStation/NTstation13.png)](https://travis-ci.org/NTStation/NTstation13)
-Website: http://ss13.eu
+Website: http://tgstation13.org/
Code: https://github.com/NTStation/Ntstation13
-Fourms: http://www.ss13.eu/phpbb
+Fourms: http://tgstation13.org/phpBB/
# DOWNLOADING
-There are a number of ways to download the source code. Some are described here, an alternative all-inclusive guide is also located at http://wiki.ss13.eu/index.php/Downloading_the_source_code
+There are a number of ways to download the source code. Some are described here, an alternative all-inclusive guide is also located at http://tgstation13.org/wiki/Downloading_the_source_code
Option 1: Download the source code as a zip by clicking the ZIP button in the
code tab of https://github.com/NTStation/Ntstation13
-(note: this will use a lot of bandwidth if you wish to update and is a lot of
+(Note: This will use a lot of bandwidth if you wish to update and is a lot of
hassle if you want to make any changes at all, so it's not recommended.)
(Options 2/3): Install Git-scm from here first: http://git-scm.com/download/win
Option 2:
Install GitHub::windows from http://windows.github.com/
It handles most of the setup and configuraton of Git for you.
-Then you simply search for the -tg-station repository and click the big clone
+Then you simply search for the NTStation13 repository and click the big clone
button.
Option 3:
-Follow this: http://wiki.ss13.eu/index.php/Setting_up_git
+Follow this: http://tgstation13.org/wiki/Setting_up_git
(It's recommended that you use git-scm, as above, rather than the git CLI
suggested by the guide)
#INSTALLATION
First-time installation should be fairly straightforward. First, you'll need
-BYOND installed. You can get it from http://www.byond.com/. Once you've done
+BYOND installed. You can get it from http://www.byond.com/. Once you've done
that, extract the game files to wherever you want to keep them. This is a
sourcecode-only release, so the next step is to compile the server files.
Open NTstation.dme by double-clicking it, open the Build menu, and click
@@ -45,7 +45,7 @@ NTstation.dmb - 0 errors, 0 warnings
If you see any errors or warnings, something has gone wrong - possibly a corrupt
download or the files extracted wrong. If problems persist, ask for assistance
-on the fourms.
+on the forums.
Once that's done, open up the config folder. You'll want to edit config.txt to
set the probabilities for different gamemodes in Secret and to set your server
@@ -60,13 +60,13 @@ your own. "Game Master" is the highest level of access, and probably the one
you'll want to use for now. You can set up your own ranks and find out more in
config/admin_ranks.txt
-The format is
+The format is:
```
byondkey = Rank
```
-where the admin rank must be properly capitalised.
+Where the admin rank must be properly capitalised.
Finally, to start the server, run Dream Daemon and enter the path to your
compiled NTstation.dmb file. Make sure to set the port to the one you
@@ -88,7 +88,7 @@ the new version.
The SQL backend for the library and stats tracking requires a
MySQL server. Your server details go in /config/dbconfig.txt, and the SQL
-schema is in /SQL/database_schema.sql. More detailed setup instructions are located here: http://wiki.ss13.eu/index.php/Downloading_the_source_code#Setting_up_the_database
+schema is in /SQL/database_schema.sql. More detailed setup instructions are located here: http://tgstation13.org/wiki/Downloading_the_source_code#Setting_up_the_database
#IRC BOT SETUP
@@ -134,23 +134,17 @@ You must use tabs to indent your code.
Hacky code, such as adding specific checks, is highly discouraged and only allowed when there is no other option. You can avoid hacky code by using object oriented methodologies, such as overriding a function (called procs in DM) or sectioning code into functions and then overriding them as required.
-Duplicated code is 99% of the time never allowed. Copying code from one place to another maybe suitable for small short time projects but /tg/station focuses on the long term and thus discourages this. Instead you can use object orientation, or simply placing repeated code in a function, to obey this specification easily.
+Duplicated code is 99% of the time never allowed. Copying code from one place to another may be suitable for small short time projects but NTStation13 focuses on the long term and thus discourages this. Instead you can use object orientation, or simply placing repeated code in a function, to obey this specification easily.
Code should be modular where possible, if you are working on a new class then it is best if you put it in a new file.
Bloated code may be necessary to add a certain feature, which means there has to be a judgement over whether the feature is worth having or not. You can help make this decision easier by making sure your code is modular.
-You are expected to help maintain the code that you add, meaning if there is a problem then you are likely to be approached in order to fix any issues, runtimes or bugs.
-
-**Other Requirements/Information**
-
-Please be kind when commiting! If you've commited to ss13 before, please message Polymorph on the fourms and request merge permissions to the master branch. Treat them well and be respectful, please!
-
-If you haven't commited before, please make a pull request and announce it on the fourms. After a few of those, we can give you merge permissions yourself.
+You are expected to help maintain the code that you add, meaning if there is a problem then you are likely to be approached in order to fix any issues, runtimes, or bugs.
**Getting Started**
-We have a [list of guides on the wiki](http://wiki.ss13.eu/index.php/Guides#Development_and_Contribution_Guides) which will help you get started contributing to /tg/station with git and Dream Maker.
+We have a [list of guides on the wiki](http://tgstation13.org/wiki/Guides#Development_and_contribution_guides) which will help you get started contributing to NTStation13 with git and Dream Maker.
For beginners, it is recommended you work on small projects, at first. There is an easy list of issues which are [contributor friendly, here](https://github.com/NTStation/NTStation13/issues?labels=Contributor+Friendly&page=1&state=open).

0 comments on commit 9992825

Please sign in to comment.