From 7e07bca21232c7f027b8e1acf876badbfbd2a66a Mon Sep 17 00:00:00 2001 From: "Justin Clark-Casey (justincc)" Date: Fri, 15 Jan 2010 17:24:24 +0000 Subject: [PATCH] * Separate out building instructions. Further revise README --- BUILDING.txt | 30 ++++++++++++++++++++++++++++++ README.txt | 52 +++++++++++++++++++++++++++------------------------- 2 files changed, 57 insertions(+), 25 deletions(-) create mode 100644 BUILDING.txt diff --git a/BUILDING.txt b/BUILDING.txt new file mode 100644 index 0000000000..03fb482226 --- /dev/null +++ b/BUILDING.txt @@ -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 diff --git a/README.txt b/README.txt index 339d6872c1..2aa59ac3ac 100644 --- a/README.txt +++ b/README.txt @@ -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 == +== Compiling OpenSim == -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 +Please see BUILDING.txt if you downloaded a source distribution and +need to build OpenSim before running it. -See configuring OpenSim +== Running OpenSim on Windows == -== Installation on Linux == +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 -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) +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: -From the distribution type: - * ./runprebuild.sh - * nant * 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: @@ -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