Skip to content

Commit

Permalink
Create gettingstarted.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Hüseyin Uslu committed Sep 26, 2014
1 parent 5bdd631 commit 6af0dd8
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. _gettingstarted:

===============
Getting Started
===============

Requirements
============

CoiniumServ is an platform-agnostic software which can either run over mono or .net. To get CoiniumServ running, all you have to do is ensuring you do have either mono or .net installed on your system;

* Linux/Unix over [mono](http://www.mono-project.com/).
* MacOS over [mono](http://www.mono-project.com/).
* Windows over [.Net](http://www.microsoft.com/net).

Once you do have either mono/.net installed, you can then run CoiniumServ. You have basically two options; compiling from source or using a binary distribution.

Binary Distribution
===================

Our binary distributions can work on any platform including Windows, Linux and MacOS. You can purchase a binary distribution over [here](http://www.coiniumserv.com/shop/releases/coiniumserv/) to support the project.

.. image:: http://i.imgur.com/MDYxtOO.png

Once you download the package, extract the contents to a suitable folder;

.. image:: http://i.imgur.com/gnspINk.png

Then you can simply run the **CoiniumServ.exe**

.. image:: (http://i.imgur.com/MhJkZxT.png

Then you have to [configure](https://github.com/CoiniumServ/CoiniumServ/wiki/Configuration) the server to get it working.

Compiling from source
=====================

If you like you can get the sources of the project and compile yourself.

* [Windows](https://github.com/CoiniumServ/CoiniumServ/wiki/Getting-Started:-Windows)
* [Linux](https://github.com/CoiniumServ/CoiniumServ/wiki/Getting-Started:-Linux)
* [MacOS](https://github.com/CoiniumServ/CoiniumServ/wiki/Getting-Started:-MacOS)

Then you have to [configure](https://github.com/CoiniumServ/CoiniumServ/wiki/Configuration) the server to get it working.

0 comments on commit 6af0dd8

Please sign in to comment.