aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md (renamed from README.txt)42
1 files changed, 12 insertions, 30 deletions
diff --git a/README.txt b/README.md
index a5dec24..552cdef 100644
--- a/README.txt
+++ b/README.md
@@ -1,8 +1,6 @@
1Welcome to OpenSim! 1Welcome to OpenSim!
2 2
3================== 3# Overview
4==== OVERVIEW ====
5==================
6 4
7OpenSim is a BSD Licensed Open Source project to develop a functioning 5OpenSim is a BSD Licensed Open Source project to develop a functioning
8virtual worlds server platform capable of supporting multiple clients 6virtual worlds server platform capable of supporting multiple clients
@@ -12,16 +10,12 @@ C#, and can run under Mono or the Microsoft .NET runtimes.
12This is considered an alpha release. Some stuff works, a lot doesn't. 10This is considered an alpha release. Some stuff works, a lot doesn't.
13If it breaks, you get to keep *both* pieces. 11If it breaks, you get to keep *both* pieces.
14 12
15========================= 13# Compiling OpenSim
16=== Compiling OpenSim ===
17=========================
18 14
19Please see BUILDING.txt if you downloaded a source distribution and 15Please see BUILDING.md if you downloaded a source distribution and
20need to build OpenSim before running it. 16need to build OpenSim before running it.
21 17
22================================== 18# Running OpenSim on Windows
23=== Running OpenSim on Windows ===
24==================================
25 19
26We recommend that you run OpenSim from a command prompt on Windows in order 20We recommend that you run OpenSim from a command prompt on Windows in order
27to capture any errors. 21to capture any errors.
@@ -33,9 +27,7 @@ To run OpenSim from a command prompt
33 27
34Now see the "Configuring OpenSim" section 28Now see the "Configuring OpenSim" section
35 29
36================================ 30# Running OpenSim on Linux
37=== Running OpenSim on Linux ===
38================================
39 31
40You will need Mono >= 2.4.3 to run OpenSim. On some Linux distributions you 32You will need Mono >= 2.4.3 to run OpenSim. On some Linux distributions you
41may need to install additional packages. See http://opensimulator.org/wiki/Dependencies 33may need to install additional packages. See http://opensimulator.org/wiki/Dependencies
@@ -48,14 +40,12 @@ To run OpenSim, from the unpacked distribution type:
48 40
49Now see the "Configuring OpenSim" section 41Now see the "Configuring OpenSim" section
50 42
51=========================== 43# Configuring OpenSim
52=== Configuring OpenSim ===
53===========================
54 44
55When OpenSim starts for the first time, you will be prompted with a 45When OpenSim starts for the first time, you will be prompted with a
56series of questions that look something like: 46series of questions that look something like:
57 47
58[09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]: 48 [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:
59 49
60For all the options except simulator name, you can safely hit enter to accept 50For all the options except simulator name, you can safely hit enter to accept
61the default if you want to connect using a client on the same machine or over 51the default if you want to connect using a client on the same machine or over
@@ -72,7 +62,7 @@ in-world. You can also use these details to perform your first login.
72 62
73Once you are presented with a prompt that looks like: 63Once you are presented with a prompt that looks like:
74 64
75 Region (My region name) # 65 Region (My region name) #
76 66
77You have successfully started OpenSim. 67You have successfully started OpenSim.
78 68
@@ -83,9 +73,7 @@ Helpful resources:
83 * http://opensimulator.org/wiki/Configuration 73 * http://opensimulator.org/wiki/Configuration
84 * http://opensimulator.org/wiki/Configuring_Regions 74 * http://opensimulator.org/wiki/Configuring_Regions
85 75
86================================== 76# Connecting to your OpenSim
87=== Connecting to your OpenSim ===
88==================================
89 77
90By default your sim will be available for login on port 9000. You can login by 78By default your sim will be available for login on port 9000. You can login by
91adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life 79adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life
@@ -96,15 +84,11 @@ http://192.168.1.2:9000)
96To login, use the avatar details that you gave for your estate ownership or the 84To login, use the avatar details that you gave for your estate ownership or the
97one you set up using the "create user" command. 85one you set up using the "create user" command.
98 86
99=================== 87# Bug reports
100=== Bug reports ===
101===================
102 88
103In the very likely event of bugs biting you (err, your OpenSim) we 89In the very likely event of bugs biting you (err, your OpenSim) we
104encourage you to see whether the problem has already been reported on 90encourage you to see whether the problem has already been reported on
105the OpenSim mantis system. You can find the OpenSim mantis system at 91the [OpenSim mantis system](http://opensimulator.org/mantis/main_page.php).
106
107 http://opensimulator.org/mantis/main_page.php
108 92
109If your bug has already been reported, you might want to add to the 93If your bug has already been reported, you might want to add to the
110bug description and supply additional information. 94bug description and supply additional information.
@@ -119,9 +103,7 @@ mantis"). Useful information to include:
119 103
120 mono --debug OpenSim.exe 104 mono --debug OpenSim.exe
121 105
122=================================== 106# More Information on OpenSim
123=== More Information on OpenSim ===
124===================================
125 107
126More extensive information on building, running, and configuring 108More extensive information on building, running, and configuring
127OpenSim, as well as how to report bugs, and participate in the OpenSim 109OpenSim, as well as how to report bugs, and participate in the OpenSim