Skip to content

Commit 5f74dc2

Browse files
committed
CXX-74 convert README to markdown and add travis badge
1 parent ef63b4a commit 5f74dc2

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README renamed to README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
MongoDB Legacy C++ Driver README
2-
1+
# MongoDB Legacy C++ Driver [![Build Status](https://travis-ci.org/mongodb/mongo-cxx-driver.png?branch=legacy)](https://travis-ci.org/mongodb/mongo-cxx-driver)
32
Welcome to the MongoDB Legacy C++ Driver!
43

54
This driver is an extraction of the "Server C++ Driver" from the primary
@@ -8,35 +7,35 @@ from the server sources if at all possible. Please note that as of
87
MongoDB 2.6.0-rc1, it is no longer possible to build the driver from
98
the server sources: this repo is the only approved source for driver builds.
109

11-
COMPONENTS
10+
## Components
1211

1312
libmongoclient.[so|dylib|dll] - The shared mongoclient library
1413
libmongoclient.a - The static mongoclient library (but see notes)
1514

16-
BUILDING
15+
## Building
1716

1817
See http://docs.mongodb.org/ecosystem/tutorial/download-and-compile-cpp-driver/
1918

2019
The above instructions (currently) assume that you are building from the server
2120
repository, but the will work with this repository as described.
2221

23-
NOTES
22+
## Notes
2423

2524
Use of the static library is discouraged, and support may be removed soon. To properly
2625
link against the static library on ELF platforms, you must link it with the
2726
--whole-archive flag to ld. The static library is not useable on Windows since
2827
there is no analogue to --whole-archive. The static library may work on OS X, but
2928
we still strongly recommend using the dynamic library.
3029

31-
DOCUMENTATION
30+
## Documentation
3231

3332
http://docs.mongodb.org/ecosystem/drivers/cpp/
3433

35-
MAIL LISTS AND IRC
34+
## Mailing Lists and IRC
3635

3736
http://dochub.mongodb.org/core/community
3837

39-
LICENSE
38+
## Licencse
4039

4140
The source files in this repository are made available under the terms of the
4241
Apache License, version 2.0.

0 commit comments

Comments
 (0)