SERVER-57684 README.md

3 files changed, 103 insertions, 86 deletions

diff --git a/README b/README
deleted file mode 100644
index 2e064ebc945..00000000000
--- a/README
+++ /dev/null
@@ -1,86 +0,0 @@
-MongoDB README

-

-Welcome to MongoDB!

-

-COMPONENTS

-

-  mongod - The database server.

-  mongos - Sharding router.

-  mongo  - The database shell (uses interactive javascript).

-

-UTILITIES

-

-  install_compass   - Installs MongoDB Compass for your platform.

-

-BUILDING

-

-  See docs/building.md.

-

-RUNNING

-

-  For command line options invoke:

-

-    $ ./mongod --help

-

-  To run a single server database:

-

-    $ sudo mkdir -p /data/db

-    $ ./mongod

-    $

-    $ # The mongo javascript shell connects to localhost and test database by default:

-    $ ./mongo

-    > help

-

-INSTALLING COMPASS

-

-  You can install compass using the install_compass script packaged with MongoDB:

-

-    $ ./install_compass

-

-  This will download the appropriate MongoDB Compass package for your platform

-  and install it.

-

-DRIVERS

-

-  Client drivers for most programming languages are available at

-  https://docs.mongodb.com/manual/applications/drivers/. Use the shell

-  ("mongo") for administrative tasks.

-

-BUG REPORTS

-

-  See https://github.com/mongodb/mongo/wiki/Submit-Bug-Reports.

-

-PACKAGING

-

-  Packages are created dynamically by the package.py script located in the

-  buildscripts directory. This will generate RPM and Debian packages.

-

-DOCUMENTATION

-

-  https://docs.mongodb.com/manual/

-

-CLOUD HOSTED MONGODB

-

-  https://www.mongodb.com/cloud/atlas

-

-FORUMS

-

-  https://community.mongodb.com

-

-    A forum for technical questions about using MongoDB.

-

-  https://community.mongodb.com/c/server-dev

-

-    A forum for technical questions about building and developing MongoDB.

-

-LEARN MONGODB

-

-  https://university.mongodb.com/

-

-LICENSE

-

-  MongoDB is free and the source is available. Versions released prior to

-  October 16, 2018 are published under the AGPL. All versions released after

-  October 16, 2018, including patch fixes for prior versions, are published

-  under the Server Side Public License (SSPL) v1. See individual files for

-  details.

diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..09ffccd7e63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,92 @@
+# ![Logo](docs/leaf.svg) MongoDB README
+
+Welcome to MongoDB!
+
+## Components
+
+  - `mongod` - The database server.
+  - `mongos` - Sharding router.
+  - `mongo`  - The database shell (uses interactive javascript).
+
+## Utilities
+
+  `install_compass` - Installs MongoDB Compass for your platform.
+
+## Building
+
+  See [Building MongoDB](docs/building.md).
+
+## Running
+
+  For command line options invoke:
+
+  ```bash
+  $ ./mongod --help
+  ```
+
+  To run a single server database:
+
+  ```bash
+    $ sudo mkdir -p /data/db
+    $ ./mongod
+    $
+    $ # The mongo javascript shell connects to localhost and test database by default:
+    $ ./mongo
+    > help
+  ```
+
+## Installing Compass
+
+  You can install compass using the `install_compass` script packaged with MongoDB:
+
+  ```bash
+    $ ./install_compass
+  ```
+
+  This will download the appropriate MongoDB Compass package for your platform
+  and install it.
+
+## Drivers
+
+  Client drivers for most programming languages are available at
+  https://docs.mongodb.com/manual/applications/drivers/. Use the shell
+  (`mongo`) for administrative tasks.
+
+## Bug Reports
+
+  See https://github.com/mongodb/mongo/wiki/Submit-Bug-Reports.
+
+## Packaging
+
+  Packages are created dynamically by the [buildscripts/packager.py](buildscripts/packager.py) script.
+  This will generate RPM and Debian packages.
+
+## Documentation
+
+  https://docs.mongodb.com/manual/
+
+## Cloud Hosted MongoDB
+
+  https://www.mongodb.com/cloud/atlas
+
+## Forums
+
+  - https://community.mongodb.com
+
+      Technical questions about using MongoDB.
+
+  - https://community.mongodb.com/c/server-dev
+
+      Technical questions about building and developing MongoDB.
+
+## Learn MongoDB
+
+  https://university.mongodb.com/
+
+## LICENSE
+
+  MongoDB is free and the source is available. Versions released prior to
+  October 16, 2018 are published under the AGPL. All versions released after
+  October 16, 2018, including patch fixes for prior versions, are published
+  under the [Server Side Public License (SSPL) v1](LICENSE-Community.txt).
+  See individual files for details.
diff --git a/docs/leaf.svg b/docs/leaf.svg
new file mode 100644
index 00000000000..2b445386b23
--- /dev/null
+++ b/docs/leaf.svg
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24px" height="38px" viewBox="0 0 12 19" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>Hero</title>
+    <desc>MongoDB Leaf</desc>
+    <g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round">
+        <g transform="translate(-2, 1)" stroke="#13AA52" stroke-width="1.5">
+            <path d="M11.3359084,8.60752857 L4.76827397,15.2602568" transform="translate(8.052091, 11.933893) rotate(-45) translate(-8.052091, -11.933893) "></path>
+            <path d="M13.5541041,2.55 C13.5541041,2.55 13.1102169,17.2285636 3.34112875,12.8924674 C-0.940766072,2.99900921 13.5541041,2.55 13.5541041,2.55 Z" transform="translate(8.052052, 8.121800) rotate(-45) translate(-8.052052, -8.121800) "></path>
+        </g>
+    </g>
+</svg>