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