citizenmp-server-updater/README.md

CitizenMP Server Updater
========================

_by Carl Kittelberger_

Updates, compiles and sets up your CitizenMP server automagically!

Features
--------

- Compatible with both Microsoft .NET Framework 4.5+ and Mono 3.0+ (Mac OS X support planned)
- Creates ready-to-use start scripts for your platform
- No extra setup besides requirements listed below needed

Requirements
------------

First of all, you'll need Windows or Linux to run this tool. Currently, since no libgit2 binaries can be provided for Mac OS X, this tool won't work there. Here's the guaranteed compatible list of OS this tool can be run on:

- Ubuntu 12.04 LTS or higher, including 14.xx
- Debian 7.x (Wheezy) or higher, including testing and sid installations
- Every other currently stable Linux distribution with up-to-date Mono
- Any Windows operating system with .NET Framework 4.5 Full on it

To run this program and the resulting server, you need the following components:

- _On Windows:_ .NET Framework 4.5 or newer ([Download](http://microsoft.com/download/details.aspx?id=30653))
- _On Linux:_ Mono 3.x or newer, runtime + xbuild files ([Installation instructions](http://www.mono-project.com/docs/getting-started/install/linux/))

*Note that Mono 2.10.x/.NET 4 are not supported!*
If you use a Debian-based distribution that still only offers Mono binaries older than 3.x, you must [switch to Xamarin's Debian repository](http://www.mono-project.com/docs/getting-started/install/linux/).

Guides
------

- [Easy server installation on Windows](docs/EasyInstall_Windows.md)
- [Server installation on Linux](docs/Terminal_Linux.md)

Usage
-----

This tool ships with a usage screen that will be printed if this tool is run without arguments. It looks similar to the following:

```
CitizenMP Server Updater 1.0.3
© 2014-2015 Carl Kittelberger

This is free software. You may redistribute copies of it under the terms of the MIT License <http://www.opensource.org/licenses/mit-license.php>.

citimp_upd [options...] "<targetpath>"

  -v, --verbosity    (Default: Quiet) Sets the build output verbosity. Possible values: Minimal, Quiet, Normal, Detailed, Diagnostic

  --source           (Default: src) Sets the path where the source files will be stored.

  --log              (Default: True) Write a log file "build.log" to the output folder.

  --version          (Default: False) Shows this tool's version.

  --help             Display this help screen.
```

Examples:

- Install server on Linux/Windows into a folder named "MyServer" via command-line: ```citimp_upd MyServer``` (on Windows) or ```mono citimp_upd.exe MyServer``` (on Linux)
- Install server on Windows into a folder named "MyServer" without command-line: Just create a folder named "MyServer" and drag-n-drop it onto citimp_upd.exe!
- Install server on Windows into "C:\Server\CitizenMP" and put the source code to "C:\Source\CitizenMP": ```citimp_upd.exe --source "C:\Source\CitizenMP" "C:\Server\CitizenMP"```
Edited readme file. 2015-01-14 07:06:31 +00:00			`CitizenMP Server Updater`
Initial commit 2015-01-04 05:32:53 +00:00			`========================`

Edited readme file. 2015-01-14 07:06:31 +00:00			`_by Carl Kittelberger_`

Initial commit 2015-01-04 05:32:53 +00:00			`Updates, compiles and sets up your CitizenMP server automagically!`
Edited readme file. 2015-01-14 07:06:31 +00:00
			`Features`
			`--------`

Updating documents. 2015-01-16 11:11:32 +00:00			`- Compatible with both Microsoft .NET Framework 4.5+ and Mono 3.0+ (Mac OS X support planned)`
Edited readme file. 2015-01-14 07:06:31 +00:00			`- Creates ready-to-use start scripts for your platform`
Updating documents. 2015-01-16 11:11:32 +00:00			`- No extra setup besides requirements listed below needed`
Edited readme file. 2015-01-14 07:06:31 +00:00
			`Requirements`
			`------------`

			`First of all, you'll need Windows or Linux to run this tool. Currently, since no libgit2 binaries can be provided for Mac OS X, this tool won't work there. Here's the guaranteed compatible list of OS this tool can be run on:`

Updating documents. 2015-01-16 11:11:32 +00:00			`- Ubuntu 12.04 LTS or higher, including 14.xx`
Edited readme file. 2015-01-14 07:06:31 +00:00			`- Debian 7.x (Wheezy) or higher, including testing and sid installations`
Updating documents. 2015-01-16 11:11:32 +00:00			`- Every other currently stable Linux distribution with up-to-date Mono`
			`- Any Windows operating system with .NET Framework 4.5 Full on it`
Edited readme file. 2015-01-14 07:06:31 +00:00
			`To run this program and the resulting server, you need the following components:`

Updating documents. 2015-01-16 11:11:32 +00:00			`- _On Windows:_ .NET Framework 4.5 or newer ([Download](http://microsoft.com/download/details.aspx?id=30653))`
			`- _On Linux:_ Mono 3.x or newer, runtime + xbuild files ([Installation instructions](http://www.mono-project.com/docs/getting-started/install/linux/))`
Edited readme file. 2015-01-14 07:06:31 +00:00
Updating documents. 2015-01-16 11:11:32 +00:00			`Note that Mono 2.10.x/.NET 4 are not supported!`
			`If you use a Debian-based distribution that still only offers Mono binaries older than 3.x, you must [switch to Xamarin's Debian repository](http://www.mono-project.com/docs/getting-started/install/linux/).`
Edited readme file. 2015-01-14 07:06:31 +00:00
Adding easy server installation guide for Windows. 2015-01-14 07:18:25 +00:00			`Guides`
			`------`

Added Linux server setup guide. 2015-01-14 07:43:57 +00:00			`- [Easy server installation on Windows](docs/EasyInstall_Windows.md)`
			`- [Server installation on Linux](docs/Terminal_Linux.md)`
Adding easy server installation guide for Windows. 2015-01-14 07:18:25 +00:00
Edited readme file. 2015-01-14 07:06:31 +00:00			`Usage`
			`-----`

			`This tool ships with a usage screen that will be printed if this tool is run without arguments. It looks similar to the following:`

			```
Updating documents. 2015-01-16 11:11:32 +00:00			`CitizenMP Server Updater 1.0.3`
Edited readme file. 2015-01-14 07:06:31 +00:00			`© 2014-2015 Carl Kittelberger`

			`This is free software. You may redistribute copies of it under the terms of the MIT License <http://www.opensource.org/licenses/mit-license.php>.`

			`citimp_upd [options...] "<targetpath>"`

			`-v, --verbosity (Default: Quiet) Sets the build output verbosity. Possible values: Minimal, Quiet, Normal, Detailed, Diagnostic`

			`--source (Default: src) Sets the path where the source files will be stored.`

			`--log (Default: True) Write a log file "build.log" to the output folder.`

			`--version (Default: False) Shows this tool's version.`

			`--help Display this help screen.`
			```

			`Examples:`

			- Install server on Linux/Windows into a folder named "MyServer" via command-line: ```citimp_upd MyServer``` (on Windows) or ```mono citimp_upd.exe MyServer``` (on Linux)
			`- Install server on Windows into a folder named "MyServer" without command-line: Just create a folder named "MyServer" and drag-n-drop it onto citimp_upd.exe!`
			- Install server on Windows into "C:\Server\CitizenMP" and put the source code to "C:\Source\CitizenMP": ```citimp_upd.exe --source "C:\Source\CitizenMP" "C:\Server\CitizenMP"```