summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDwight <dmerriman@gmail.com>2009-10-22 10:45:50 -0400
committerDwight <dmerriman@gmail.com>2009-10-22 10:45:50 -0400
commit7e297a03c1efe22288548a913bdae853c3dd5def (patch)
treeae73b91af20fba9c8f4d138430de686664929dfe /README
parent1d6e22725127dbf115fef9e318807e7f8eaf73a3 (diff)
downloadmongo-7e297a03c1efe22288548a913bdae853c3dd5def.tar.gz
update README
MINOR
Diffstat (limited to 'README')
-rw-r--r--README72
1 files changed, 37 insertions, 35 deletions
diff --git a/README b/README
index 359f4c8bfaf..5b231bfb3ff 100644
--- a/README
+++ b/README
@@ -1,14 +1,14 @@
-Mongo DB README
+MongoDB README
DOCUMENTATION
-http://www.mongodb.org/display/DOCS/Home
+ http://www.mongodb.org/
COMPONENTS
-mongod - The database process.
-mongos - Sharding controller (sharding available later in Q209).
-mongo - The interact javascript db shell.
+ mongod - The database process.
+ mongos - Sharding controller.
+ mongo - The database shell (uses interactive javascript).
BUILDING
@@ -16,9 +16,6 @@ BUILDING
http://www.mongodb.org/display/DOCS/Building
-
-- Then use scons to build.
-
If you want to build everything (mongod, mongo, tools, etc):
$ scons .
@@ -31,46 +28,51 @@ BUILDING
$ scons --prefix=/opt/mongo install
+ Please note that prebuilt binaries are available on mongodb.org and may be the easier way to get started.
+
RUNNING
-Run ./mongod and command line options will display.
+ ./mongod
+
+ runs the database. Use
+
+ ./mongod --help
+
+ to see command line options.
COMPILER VERSIONS
-Mongo has been tested with GCC 4.1.2 and Visual Studio 2008. Older versions
-of GCC may not be happy.
+ Mongo has been tested with GCC 4.x and Visual Studio 2008. Older versions
+ of GCC may not be happy.
NOTES
-Mongo uses memory mapped files. If built as a 32 bit executable, you will
-not be able to work with large (multi-gigabyte) databases. However, 32 bit
-builds work fine with small development databases.
+ Mongo uses memory mapped files. If built as a 32 bit executable, you will
+ not be able to work with large (multi-gigabyte) databases. However, 32 bit
+ builds work fine with small development databases.
+
+WINDOWS
---- WINDOWS ---
+ See also http://www.mongodb.org/display/DOCS/Building+for+Windows
-See also http://www.mongodb.org/display/DOCS/Building+for+Windows
+ Build requirements:
+ - vc++ express or visual studio
+ - python 2.5 (for scons - 2.6 might be needed for some regression tests)
+ - scons
+ - boost 1.35 (or higher)
+ - windows sdk - tested with v6.0 v6.0a
-COMPILING
- REQUIREMENTS
- - python 2.5 (for scons - 2.6 might be needed for some regression tests)
- - scons
- - boost 1.35
- - vc++ express
- - windows sdk - tested with v6.0 v6.0a
+ Or download a prebuilt binary for Windows at www.mongodb.org.
- scons
- mkdir \data\
- mkdir \data\db
- db\db run
+UBUNTU
+ scons libboost-dev libpcre++-dev xulrunner-1.9.1-dev
---- ubuntu ---
- scons libboost-dev libpcre++-dev xulrunner-1.9.1-dev
+FreeBSD
---- FreeBSD ---
+ Install the following ports:
-Install the following ports:
- - devel/boost
- - devel/libexecinfo
- - devel/pcre
- - lang/spidermonkey
+ - devel/boost
+ - devel/libexecinfo
+ - devel/pcre
+ - lang/spidermonkey