diff options
author | Sean Dague | 2007-09-17 13:06:07 +0000 |
---|---|---|
committer | Sean Dague | 2007-09-17 13:06:07 +0000 |
commit | 5ab73ae026b9837468533535ac696d97515f72d0 (patch) | |
tree | e42d533e850e9ba045864af9537536d68726e7b7 | |
parent | fixing me some line endings (diff) | |
download | opensim-SC-5ab73ae026b9837468533535ac696d97515f72d0.zip opensim-SC-5ab73ae026b9837468533535ac696d97515f72d0.tar.gz opensim-SC-5ab73ae026b9837468533535ac696d97515f72d0.tar.bz2 opensim-SC-5ab73ae026b9837468533535ac696d97515f72d0.tar.xz |
added top level README file. It would be good if
people looked this over
-rw-r--r-- | .nant/local.include | 1 | ||||
-rw-r--r-- | README | 97 |
2 files changed, 98 insertions, 0 deletions
diff --git a/.nant/local.include b/.nant/local.include index 7e1627c..48955aa 100644 --- a/.nant/local.include +++ b/.nant/local.include | |||
@@ -6,6 +6,7 @@ | |||
6 | <fileset basedir="."> | 6 | <fileset basedir="."> |
7 | <include name="ThirdPartyLicenses/**" /> | 7 | <include name="ThirdPartyLicenses/**" /> |
8 | <include name="CONTRIBUTORS.txt" /> | 8 | <include name="CONTRIBUTORS.txt" /> |
9 | <include name="README" /> | ||
9 | <include name="OpenSim/**/*.cs" /> | 10 | <include name="OpenSim/**/*.cs" /> |
10 | <include name="**/*.build" /> | 11 | <include name="**/*.build" /> |
11 | <include name="**/*.csproj" /> | 12 | <include name="**/*.csproj" /> |
@@ -0,0 +1,97 @@ | |||
1 | Welcome to OpenSim! | ||
2 | |||
3 | Version 0.4 | ||
4 | |||
5 | == LICENSE == | ||
6 | |||
7 | Copyright (c) Contributors, http://opensimulator.org/ | ||
8 | See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
9 | |||
10 | Redistribution and use in source and binary forms, with or without | ||
11 | modification, are permitted provided that the following conditions are met: | ||
12 | * Redistributions of source code must retain the above copyright | ||
13 | notice, this list of conditions and the following disclaimer. | ||
14 | * Redistributions in binary form must reproduce the above copyright | ||
15 | notice, this list of conditions and the following disclaimer in the | ||
16 | documentation and/or other materials provided with the distribution. | ||
17 | * Neither the name of the OpenSim Project nor the | ||
18 | names of its contributors may be used to endorse or promote products | ||
19 | derived from this software without specific prior written permission. | ||
20 | |||
21 | THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY EXPRESS OR | ||
22 | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
23 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
24 | DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
25 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
26 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE | ||
27 | GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
28 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER | ||
29 | IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR | ||
30 | OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF | ||
31 | ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
32 | |||
33 | == OVERVIEW == | ||
34 | |||
35 | OpenSim is a BSD Licensed Open Source project to develop a functioning | ||
36 | virtual worlds server platform capable of supporting multiple clients | ||
37 | and servers in a heterogeneous grid structure. OpenSim is written in | ||
38 | C#, and can run under Mono or the Microsoft .NET runtimes. | ||
39 | |||
40 | This is considered and alpha release. Some stuff works, a lot | ||
41 | doesn't. If it breaks, you get to keep *both* pieces. | ||
42 | |||
43 | == Installation on Windows == | ||
44 | |||
45 | Prereqs: | ||
46 | |||
47 | * Load OpenSim.sln into Visual Studio .NET and build the solution. | ||
48 | * chdir bin | ||
49 | * OpenSim.exe | ||
50 | |||
51 | See configuring OpenSim | ||
52 | |||
53 | == Installation on Linux == | ||
54 | |||
55 | Prereqs: | ||
56 | * Mono >= 1.2.3.1 | ||
57 | * Nant >= 0.85 | ||
58 | * sqlite3 | ||
59 | |||
60 | From the distribution type: | ||
61 | * nant | ||
62 | * cd bin | ||
63 | * mono ./OpenSim.exe | ||
64 | |||
65 | See configuring OpenSim | ||
66 | |||
67 | == Configuring OpenSim == | ||
68 | |||
69 | When OpenSim starts for the first time, you will be prompted with a | ||
70 | series of questions that look something like: | ||
71 | |||
72 | [09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]: | ||
73 | |||
74 | At each of these you must provide you own value or just hit enter to | ||
75 | take the default (in this case "OpenSim Test"). | ||
76 | |||
77 | YOUR SIM WILL NOT BE STARTED UNTIL YOU ANSWER ALL QUESTIONS | ||
78 | |||
79 | Once you are presented with a prompt that looks like: | ||
80 | |||
81 | Region# : | ||
82 | |||
83 | You have successfully started OpenSim. | ||
84 | |||
85 | == Connecting to your OpenSim == | ||
86 | |||
87 | By default your sim will be running on http://127.0.0.1:9000. To use | ||
88 | your OpenSim add -loginuri http://127.0.0.1:9000 to your second life | ||
89 | client (running on the same machine as your OpenSim). | ||
90 | |||
91 | == More Information on OpenSim == | ||
92 | |||
93 | More extensive information on building, running, and configuring | ||
94 | OpenSim, as well as how to report bugs, and participate in the OpenSim | ||
95 | project can always be found at http://opensimulator.org. | ||
96 | |||
97 | Thanks for trying OpenSim, we hope it was a pleasant experience. | ||