Skip to content

Commit

Permalink
* Separate out building instructions. Further revise README
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Clark-Casey (justincc) committed Jan 15, 2010
1 parent 88d2adc commit 7e07bca
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 30 deletions.
30 changes: 30 additions & 0 deletions BUILDING.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
== Building OpenSim ==

=== Building on Windows ===

Steps:
* runprebuild.bat
* Load OpenSim.sln into Visual Studio .NET and build the solution.
* chdir bin
* copy OpenSim.ini.example to OpenSim.ini and other appropriate files in bin/config-include
* run OpenSim.exe

=== Building on Linux ===

Prereqs:
* Mono >= 2.4.2
* Nant >= 0.85
* On some Linux distributions you may need to install additional packages.
See http://opensimulator.org/wiki/Dependencies for more information.

From the distribution type:
* ./runprebuild.sh
* nant
* cd bin
* copy OpenSim.ini.example to OpenSim.ini and other appropriate files in bin/config-include
* run mono OpenSim.exe

=== References ===

Helpful resources:
* http://opensimulator.org/wiki/Build_Instructions
62 changes: 32 additions & 30 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,38 @@ C#, and can run under Mono or the Microsoft .NET runtimes.
This is considered an alpha release. Some stuff works, a lot doesn't.
If it breaks, you get to keep *both* pieces.

== Installation on Windows ==

Prereqs:
* runprebuild.bat
* Load OpenSim.sln into Visual Studio .NET and build the solution.
* chdir bin
* edit OpenSim.ini and appropriate files in bin/config-include
* OpenSim.exe

Helpful resources:
* http://opensimulator.org/wiki/Build_Instructions

See configuring OpenSim

== Installation on Linux ==

Prereqs:
* Mono >= 2.4.2
* Nant >= 0.86 beta 1 (if building with the .NET framework on Windows), 0.85 (if building with the mono framework)
* sqlite3 or mysql 5.x (you'll need a backend database)

From the distribution type:
* ./runprebuild.sh
* nant
== Compiling OpenSim ==

Please see BUILDING.txt if you downloaded a source distribution and
need to build OpenSim before running it.

== Running OpenSim on Windows ==

We recommend that you run OpenSim from a command prompt on Windows in order
to capture any errors, though you can also run it by double-clicking
bin/OpenSim.exe

To run OpenSim from a command prompt

* cd to the bin/ directory where you unpacked OpenSim
* run OpenSim.exe

Now see the "Configuring OpenSim" section

== Running OpenSim on Linux ==

You will need Mono >= 2.4.2 to run OpenSim. On some Linux distributions you
may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
for more information.

To run OpenSim, from the unpacked distribution type:

* cd bin
* edit OpenSim.ini and appropriate files in bin/config-include
* mono ./OpenSim.exe

See configuring OpenSim
Now see the "Configuring OpenSim" section

== Configuring OpenSim ==
Helpful resources:
* http://opensimulator.org/wiki/Configuration
* http://opensimulator.org/wiki/Configuring_Regions
* http://opensimulator.org/wiki/Mysql-config

When OpenSim starts for the first time, you will be prompted with a
series of questions that look something like:
Expand All @@ -62,6 +59,11 @@ Once you are presented with a prompt that looks like:

You have successfully started OpenSim.

Helpful resources:
* http://opensimulator.org/wiki/Configuration
* http://opensimulator.org/wiki/Configuring_Regions
* http://opensimulator.org/wiki/Mysql-config

== Connecting to your OpenSim ==

By default your sim will be running on http://127.0.0.1:9000. To use
Expand Down

0 comments on commit 7e07bca

Please sign in to comment.