Permalink
Browse files

Change README to use markdown

  • Loading branch information...
1 parent d67d476 commit 0ea2ebada59c9519296b17b739749fb5452d2a44 @bububa committed Dec 25, 2010
Showing with 110 additions and 50 deletions.
  1. +3 −4 MongoHub.xcodeproj/syd.mode1v3
  2. +23 −1 MongoHub.xcodeproj/syd.pbxuser
  3. +84 −45 README
@@ -332,7 +332,7 @@
<key>_historyCapacity</key>
<integer>0</integer>
<key>bookmark</key>
- <string>1DCB3D7112C652A700423160</string>
+ <string>1DCB3D7412C6532500423160</string>
<key>history</key>
<array>
<string>1D93C3E211836A06003216F7</string>
@@ -635,13 +635,12 @@
<integer>5</integer>
<key>WindowOrderList</key>
<array>
- <string>1DCB3D7212C652A700423160</string>
<string>1DCB3C5512C6124000423160</string>
<string>1DCB3C5612C6124000423160</string>
+ <string>1C78EAAD065D492600B07095</string>
<string>1CD10A99069EF8BA00B06720</string>
<string>1D93C1AB118329FB003216F7</string>
<string>/Users/syd/Documents/Works/codes/MongoHub/MongoHub.xcodeproj</string>
- <string>1C78EAAD065D492600B07095</string>
</array>
<key>WindowString</key>
<string>0 73 1129 705 0 0 1280 778 </string>
@@ -1017,7 +1016,7 @@
<key>WindowToolGUID</key>
<string>1C78EAAD065D492600B07095</string>
<key>WindowToolIsVisible</key>
- <true/>
+ <false/>
</dict>
<dict>
<key>Identifier</key>
@@ -564,7 +564,7 @@
uiCtxt = {
sepNavIntBoundsRect = "{{0, 0}, {801, 16159}}";
sepNavSelRange = "{5923, 0}";
- sepNavVisRange = "{5164, 1266}";
+ sepNavVisRange = "{5164, 1366}";
sepNavWindowFrame = "{{456, 164}, {813, 537}}";
};
};
@@ -3820,6 +3820,26 @@
vrLen = 1266;
vrLoc = 5164;
};
+ 1DCB3D7312C6532300423160 /* PBXTextBookmark */ = {
+ isa = PBXTextBookmark;
+ fRef = 1D93C60A11841865003216F7 /* MongoDB.mm */;
+ name = "MongoDB.mm: 848";
+ rLen = 0;
+ rLoc = 32196;
+ rType = 0;
+ vrLen = 930;
+ vrLoc = 31596;
+ };
+ 1DCB3D7412C6532500423160 /* PBXTextBookmark */ = {
+ isa = PBXTextBookmark;
+ fRef = 1D93C60A11841865003216F7 /* MongoDB.mm */;
+ name = "MongoDB.mm: 197";
+ rLen = 0;
+ rLoc = 5923;
+ rType = 0;
+ vrLen = 1366;
+ vrLoc = 5164;
+ };
1DCC55C112C254E10025F181 /* PBXTextBookmark */ = {
isa = PBXTextBookmark;
fRef = 1D975B3F12C22C660070234E /* Sparkle.h */;
@@ -4791,6 +4811,8 @@
1DCB3D6F12C652A700423160 /* PBXTextBookmark */ = 1DCB3D6F12C652A700423160 /* PBXTextBookmark */;
1DCB3D7012C652A700423160 /* XCBuildMessageTextBookmark */ = 1DCB3D7012C652A700423160 /* XCBuildMessageTextBookmark */;
1DCB3D7112C652A700423160 /* PBXTextBookmark */ = 1DCB3D7112C652A700423160 /* PBXTextBookmark */;
+ 1DCB3D7312C6532300423160 /* PBXTextBookmark */ = 1DCB3D7312C6532300423160 /* PBXTextBookmark */;
+ 1DCB3D7412C6532500423160 /* PBXTextBookmark */ = 1DCB3D7412C6532500423160 /* PBXTextBookmark */;
1DCC55C112C254E10025F181 = 1DCC55C112C254E10025F181 /* PBXTextBookmark */;
1DCC55C212C254E10025F181 = 1DCC55C212C254E10025F181 /* PBXTextBookmark */;
1DCC55C312C254E10025F181 = 1DCC55C312C254E10025F181 /* PBXTextBookmark */;
View
129 README
@@ -1,45 +1,84 @@
-MongoHub (http://mongohub.todayclose.com/) is a mongodb(http://mongodb.org) GUI application.
-This repository is a mac native version of MongoHub. If you are using windows or linux please download use the source from http://github.com/bububa/MongoHub which is made by Titanium Desktop.
-
-This project is very new. Any issues or bug reports are welcome.
-
-*If you are using the version less than 2.0.8, you need to remove ~/Library/Application\ Support/MongoHub directory and restart the new version.
-
-[Last Update 2.2.0]
-SSH Tunnel connection support;
-Fixed a bug in display ObjectID type fields;
-Fixed some UI bugs;
-Fixed some memory leaks and random crashes;
-Add confirm panel before drop database or collection;
-Run queries in a seperate thread so that won't block the UI;
-Fixed a bug to install on some 10.6.x(64bit) system.
-
-[Last Update 2.1.0]
-Auto expand and collaspe finding results;
-Display Date_t or Timestamp as GMT time format;
-Fixed a bug in display ObjectIds in Array element;
-Import data from mysql database to mongodb;
-Export data from mongodb to mysql database.
-
-[Last Update 2.0.9]
-Add support for mongohq.com;
-Changed update behavior;
-Fixed a bug to detect NumberLong type of BSONElement;
-Fixed a bug in Array type of BSONElement.
-
-[Last Update 2.0.8]
-1. Fix several UI bugs in Query Window;
-2. Fix bugs in Find Query and Update Query;
-3. Fix bugs related to ObjectId;
-4. Fix copy&paste bugs.
-
-[2.0.7]
-Add sparkle framework to check application updates.
-
-[2.0.6]
-1. fixed some UI bugs;
-2. add admin auth support.
-
-Syd
-prof.syd.xu@gmail.com
-http://twitter.com/bububa
+# MongoHub
+
+## What is MongoHub
+**[MongoHub](http://mongohub.todayclose.com/)** is a **[mongodb](http://mongodb.org)** GUI application.
+This repository is a mac native version of MongoHub. If you are using windows or linux please download use the source from [http://github.com/bububa/MongoHub](http://github.com/bububa/MongoHub) which is made by Titanium Desktop.
+
+## System Requirements
+
+Mac OS X(10.6.x), intel(64bit) based.
+
+## Installation
+
+You can either download the compiled executable file from [here](https://github.com/downloads/bububa/MongoHub-Mac/MongoHub.zip)
+or clone the source code and compile it on your own system.
+
+## Build
+
+Before builing ensure the following frameworks are present:
+ /Library/PrivateFrameworks
+ BWToolkitFramework.framework
+ Sparkle.framework
+ MCPKit_bundled.framework
+
+The project also expects Boost libraries and the MongoDB client libraries.
+
+The following Xcode project settings were changed from the master project:
+ Header Search Paths: /usr/local/include/
+ Library Search Paths: /opt/local/lib ~/source/mongo (path to mongo source)
+ User Header Search Paths: /opt/local/include ~/source (path to source projects)
+
+Thanks [HybridDBA](https://github.com/HybridDBA) add this build guide.
+
+## Current Status
+
+This project is very new. Any issues or bug reports are welcome. And I still don't have time to write a **usage guide**.
+
+## History
+
+** [Last Update 2.2.0] **
+- SSH Tunnel connection support;
+- Fixed a bug in display ObjectID type fields;
+- Fixed some UI bugs;
+- Fixed some memory leaks and random crashes;
+- Add confirm panel before drop database or collection;
+- Run queries in a seperate thread so that won't block the UI;
+- Fixed a bug to install on some 10.6.x(64bit) system.
+
+** [2.1.0] **
+- Auto expand and collaspe finding results;
+- Display Date_t or Timestamp as GMT time format;
+- Fixed a bug in display ObjectIds in Array element;
+- Import data from mysql database to mongodb;
+- Export data from mongodb to mysql database.
+
+** [2.0.9] **
+- Add support for mongohq.com;
+- Changed update behavior;
+- Fixed a bug to detect NumberLong type of BSONElement;
+- Fixed a bug in Array type of BSONElement.
+
+** [2.0.8] **
+- Fix several UI bugs in Query Window;
+- Fix bugs in Find Query and Update Query;
+- Fix bugs related to ObjectId;
+- Fix copy&paste bugs.
+
+** [2.0.7] **
+- Add sparkle framework to check application updates.
+
+** [2.0.6] **
+- fixed some UI bugs;
+- add admin auth support.
+
+## Contribute
+
+I'd love to include your contributions, friend. Make sure your methods are
+[TomDoc](http://tomdoc.org)'d properly, that existing tests pass, and
+that any new functionality includes appropriate tests.
+
+Then [send me a pull request](https://github.com/bububa/MongoHub-Mac/pull/new/master)!
+
+## Contact Me
+
+[Syd](mailto:prof.syd.xu@gmail.com) made this. Ping me on Twitter —[@bububa](http://twitter.com/bububa) — or [email](mailto:prof.syd.xu@gmail.com) me if you're having issues, or want me to merge in your pull request.

0 comments on commit 0ea2eba

Please sign in to comment.