summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 32 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1fe5926
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+MongoDB README
+
+DOCUMENTATION
+
+ http://www.mongodb.org/
+
+COMPONENTS
+
+ mongod - The database process.
+ mongos - Sharding controller.
+ mongo - The database shell (uses interactive javascript).
+
+BUILDING
+
+ see docs/building.md
+
+
+RUNNING
+
+ ./mongod
+
+ runs the database. Use
+
+ ./mongod --help
+
+ to see command line options.
+
+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.