summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEliot Horowitz <eliot@10gen.com>2009-11-19 10:49:34 -0500
committerEliot Horowitz <eliot@10gen.com>2009-11-19 10:49:34 -0500
commit571d3771c3c818dd10549ff2cbb72b797de7d320 (patch)
tree8e5119bddb1e6bdee52a81a7c6a23488d5aecf4f
parent420a7e51f07a92e35d4c6c78358b974ad0e6b582 (diff)
downloadmongo-571d3771c3c818dd10549ff2cbb72b797de7d320.tar.gz
cleaning build docs
-rw-r--r--.gitignore3
-rw-r--r--README50
-rw-r--r--docs/building.md58
3 files changed, 62 insertions, 49 deletions
diff --git a/.gitignore b/.gitignore
index 9ff16b56954..997323feede 100644
--- a/.gitignore
+++ b/.gitignore
@@ -42,7 +42,8 @@ tags
dump
log
logs
-docs
+docs/html
+docs/latex
32bit
scratch
diff --git a/README b/README
index 5b231bfb3ff..1fe592695f1 100644
--- a/README
+++ b/README
@@ -11,24 +11,9 @@ COMPONENTS
mongo - The database shell (uses interactive javascript).
BUILDING
+
+ see docs/building.md
- For detail information about building, please see:
-
- http://www.mongodb.org/display/DOCS/Building
-
- If you want to build everything (mongod, mongo, tools, etc):
-
- $ scons .
-
- If you only want to build the database:
-
- $ scons
-
- To install
-
- $ 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
@@ -40,39 +25,8 @@ RUNNING
to see command line options.
-COMPILER VERSIONS
-
- 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.
-
-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
-
- Or download a prebuilt binary for Windows at www.mongodb.org.
-
-UBUNTU
-
- scons libboost-dev libpcre++-dev xulrunner-1.9.1-dev
-
-FreeBSD
-
- Install the following ports:
-
- - devel/boost
- - devel/libexecinfo
- - devel/pcre
- - lang/spidermonkey
diff --git a/docs/building.md b/docs/building.md
new file mode 100644
index 00000000000..d3a71f6e369
--- /dev/null
+++ b/docs/building.md
@@ -0,0 +1,58 @@
+
+Building MongoDB
+================
+
+Scons
+----------------
+
+ For detail information about building, please see:
+ http://www.mongodb.org/display/DOCS/Building
+
+ If you want to build everything (mongod, mongo, tools, etc):
+
+ $ scons .
+
+ If you only want to build the database:
+
+ $ scons
+
+ To install
+
+ $ scons --prefix=/opt/mongo install
+
+ Please note that prebuilt binaries are available on mongodb.org and may be the easier way to get started.
+
+*general notes
+---------------
+ COMPILER VERSIONS
+
+ Mongo has been tested with GCC 4.x and Visual Studio 2008. Older versions
+ of GCC may not be happy.
+
+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
+
+ Or download a prebuilt binary for Windows at www.mongodb.org.
+
+ubuntu
+--------------
+
+ scons libboost-dev libpcre++-dev xulrunner-1.9.1-dev
+
+FreeBSD
+
+ Install the following ports:
+
+ - devel/boost
+ - devel/libexecinfo
+ - devel/pcre
+ - lang/spidermonkey