converted INSTALL to Markdown
moved licensing information to the README
This commit is contained in:
79
INSTALL
79
INSTALL
@@ -1,79 +0,0 @@
|
|||||||
Copyright 2007-2014 The OpenRA Developers (see AUTHORS)
|
|
||||||
This file is part of OpenRA, which is free software. It is made
|
|
||||||
available to you under the terms of the GNU General Public License
|
|
||||||
as published by the Free Software Foundation. For more information,
|
|
||||||
see COPYING.
|
|
||||||
|
|
||||||
To run OpenRA, several files are needed from the original game disks.
|
|
||||||
A minimal asset pack can also be downloaded and installed by the game.
|
|
||||||
|
|
||||||
Windows
|
|
||||||
-------
|
|
||||||
|
|
||||||
* .NET Framework >= 4.0 (Client Profile)
|
|
||||||
(http://www.microsoft.com/en-us/download/details.aspx?id=17113)
|
|
||||||
* Cg Toolkit >= 2.2 (optional, for Cg renderer)
|
|
||||||
(https://developer.nvidia.com/cg-toolkit-download)
|
|
||||||
* SDL 1.2 (included)
|
|
||||||
(http://libsdl.org/download-1.2.php)
|
|
||||||
* SDL 2 (optional)
|
|
||||||
(http://www.libsdl.org/download-2.0.php)
|
|
||||||
* FreeType (included)
|
|
||||||
(http://gnuwin32.sourceforge.net/packages/freetype.htm)
|
|
||||||
* zlib (included)
|
|
||||||
(http://gnuwin32.sourceforge.net/packages/zlib.htm)
|
|
||||||
* OpenAL (included)
|
|
||||||
(http://kcat.strangesoft.net/openal.html)
|
|
||||||
|
|
||||||
To compile OpenRA, open the OpenRA.sln solution in the main folder,
|
|
||||||
or build it from the command-line with MSBuild.
|
|
||||||
|
|
||||||
Copy both the native DLLs from .\packaging\windows
|
|
||||||
and the CLI images from .\thirdparty to the main folder.
|
|
||||||
|
|
||||||
Run the game with `OpenRA.Game.exe Game.Mod=ra` for Red Alert
|
|
||||||
or `OpenRA.Game.exe Game.Mod=cnc` for Tiberian Dawn.
|
|
||||||
|
|
||||||
Debian/Ubuntu
|
|
||||||
-------------
|
|
||||||
|
|
||||||
* mono-dmcs
|
|
||||||
* libmono-winforms2.0-cil
|
|
||||||
* cli-common-dev (>= 2.10)
|
|
||||||
* freetype
|
|
||||||
* openal
|
|
||||||
* sdl
|
|
||||||
* nvidia-cg-toolkit (optional, for Cg renderer)
|
|
||||||
|
|
||||||
To compile OpenRA, run `make all' from the command line.
|
|
||||||
To grab the bundled CLI DLLs type `make dependencies'
|
|
||||||
Run with either `launch-game.sh' or `mono --debug OpenRA.Game.exe'.
|
|
||||||
|
|
||||||
Type 'sudo make install-all' for system wide installation. You
|
|
||||||
can then run from the `openra` shortcut.
|
|
||||||
|
|
||||||
Slackware
|
|
||||||
---------
|
|
||||||
|
|
||||||
The following packages from slackbuilds.org are required, on 13.37 32-bit:
|
|
||||||
* libgdiplus
|
|
||||||
* mono
|
|
||||||
* openAL
|
|
||||||
* nvidia-cg-toolkit (optional, for Cg renderer)
|
|
||||||
|
|
||||||
openSUSE
|
|
||||||
--------
|
|
||||||
|
|
||||||
* mono-devel
|
|
||||||
* openal
|
|
||||||
* freetype2
|
|
||||||
* SDL
|
|
||||||
* cg (optional, for Cg renderer)
|
|
||||||
|
|
||||||
Gentoo
|
|
||||||
------
|
|
||||||
|
|
||||||
* dev-lang/mono
|
|
||||||
* dev-dotnet/libgdiplus
|
|
||||||
* media-libs/openal
|
|
||||||
* media-gfx/nvidia-cg-toolkit (optional, for Cg renderer)
|
|
||||||
71
INSTALL.md
Normal file
71
INSTALL.md
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
To run OpenRA, several files are needed from the original game disks.
|
||||||
|
A minimal asset pack can also be downloaded and installed by the game.
|
||||||
|
|
||||||
|
The following lists per-platform dependencies required to build from source.
|
||||||
|
|
||||||
|
Windows
|
||||||
|
=======
|
||||||
|
|
||||||
|
* [.NET Framework >= 4.0 (Client Profile)](http://www.microsoft.com/en-us/download/details.aspx?id=17113)
|
||||||
|
* [Cg Toolkit >= 2.2 (optional, for Cg renderer)](https://developer.nvidia.com/cg-toolkit-download)
|
||||||
|
* [SDL 1.2 (included)](http://libsdl.org/download-1.2.php)
|
||||||
|
* [SDL 2 (optional)](http://www.libsdl.org/download-2.0.php)
|
||||||
|
* [FreeType (included)](http://gnuwin32.sourceforge.net/packages/freetype.htm)
|
||||||
|
* [zlib (included)](http://gnuwin32.sourceforge.net/packages/zlib.htm)
|
||||||
|
* [OpenAL (included)](http://kcat.strangesoft.net/openal.html)
|
||||||
|
|
||||||
|
To compile OpenRA, open the `OpenRA.sln` solution in the main folder,
|
||||||
|
or build it from the command-line with MSBuild.
|
||||||
|
|
||||||
|
Copy both the native DLLs from `.\packaging\windows`
|
||||||
|
and the CLI images from `.\thirdparty` to the main folder.
|
||||||
|
|
||||||
|
Run the game with `OpenRA.Game.exe Game.Mod=ra` for Red Alert
|
||||||
|
or `OpenRA.Game.exe Game.Mod=cnc` for Tiberian Dawn.
|
||||||
|
|
||||||
|
Linux
|
||||||
|
=====
|
||||||
|
|
||||||
|
To grab the bundled CLI DLLs type `make dependencies`.
|
||||||
|
To compile OpenRA, run `make all` from the command line.
|
||||||
|
Run with either `launch-game.sh' or `mono --debug OpenRA.Game.exe'.
|
||||||
|
|
||||||
|
Type 'sudo make install-all' for system wide installation. You
|
||||||
|
can then run from the `openra` shortcut.
|
||||||
|
|
||||||
|
Debian/Ubuntu
|
||||||
|
-------------
|
||||||
|
|
||||||
|
* mono-dmcs
|
||||||
|
* libmono-winforms2.0-cil
|
||||||
|
* cli-common-dev (>= 2.10)
|
||||||
|
* freetype
|
||||||
|
* openal
|
||||||
|
* sdl
|
||||||
|
* nvidia-cg-toolkit (optional, for Cg renderer)
|
||||||
|
|
||||||
|
Slackware
|
||||||
|
---------
|
||||||
|
|
||||||
|
The following packages from slackbuilds.org are required, on 13.37 32-bit:
|
||||||
|
* libgdiplus
|
||||||
|
* mono
|
||||||
|
* openAL
|
||||||
|
* nvidia-cg-toolkit (optional, for Cg renderer)
|
||||||
|
|
||||||
|
openSUSE
|
||||||
|
--------
|
||||||
|
|
||||||
|
* mono-devel
|
||||||
|
* openal
|
||||||
|
* freetype2
|
||||||
|
* SDL
|
||||||
|
* cg (optional, for Cg renderer)
|
||||||
|
|
||||||
|
Gentoo
|
||||||
|
------
|
||||||
|
|
||||||
|
* dev-lang/mono
|
||||||
|
* dev-dotnet/libgdiplus
|
||||||
|
* media-libs/openal
|
||||||
|
* media-gfx/nvidia-cg-toolkit (optional, for Cg renderer)
|
||||||
@@ -21,7 +21,7 @@ Check our [Playing the Game](https://github.com/OpenRA/OpenRA/wiki/Playing-the-g
|
|||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
* Please read [INSTALL](https://github.com/OpenRA/OpenRA/blob/bleed/INSTALL) and [Compiling](https://github.com/OpenRA/OpenRA/wiki/Compiling) on how to set up an OpenRA development environment.
|
* Please read [INSTALL.md](https://github.com/OpenRA/OpenRA/blob/bleed/INSTALL.md) and [Compiling](https://github.com/OpenRA/OpenRA/wiki/Compiling) on how to set up an OpenRA development environment.
|
||||||
* See [Hacking](https://github.com/OpenRA/OpenRA/wiki/Hacking) for an overview of the engine.
|
* See [Hacking](https://github.com/OpenRA/OpenRA/wiki/Hacking) for an overview of the engine.
|
||||||
* To get your patches merged, please adhere to the [Contributing](https://github.com/OpenRA/OpenRA/blob/bleed/CONTRIBUTING.md) guidelines.
|
* To get your patches merged, please adhere to the [Contributing](https://github.com/OpenRA/OpenRA/blob/bleed/CONTRIBUTING.md) guidelines.
|
||||||
|
|
||||||
@@ -42,3 +42,10 @@ Check our [Playing the Game](https://github.com/OpenRA/OpenRA/wiki/Playing-the-g
|
|||||||
* Sponsor a [mirror server](https://github.com/OpenRA/OpenRAWeb/tree/master/content/packages) if you have some bandwidth to spare.
|
* Sponsor a [mirror server](https://github.com/OpenRA/OpenRAWeb/tree/master/content/packages) if you have some bandwidth to spare.
|
||||||
* You can immediately set up a [Dedicated](https://github.com/OpenRA/OpenRA/wiki/Dedicated) Game Server.
|
* You can immediately set up a [Dedicated](https://github.com/OpenRA/OpenRA/wiki/Dedicated) Game Server.
|
||||||
* Fund development by creating [Bounties](https://www.bountysource.com/trackers/36085-openra) on specific tasks.
|
* Fund development by creating [Bounties](https://www.bountysource.com/trackers/36085-openra) on specific tasks.
|
||||||
|
|
||||||
|
## License
|
||||||
|
Copyright 2007-2014 The OpenRA Developers (see [AUTHORS](https://github.com/OpenRA/OpenRA/blob/bleed/AUTHORS))
|
||||||
|
This file is part of OpenRA, which is free software. It is made
|
||||||
|
available to you under the terms of the GNU General Public License
|
||||||
|
as published by the Free Software Foundation. For more information,
|
||||||
|
see [COPYING](https://github.com/OpenRA/OpenRA/blob/bleed/COPYING).
|
||||||
Reference in New Issue
Block a user