Date: Wednesday, February 7, 2007 @ 12:01:54
Author: marc
Path: /cvsroot/carob/carob
Modified: README (1.1 -> 1.2)
Added FreeBSD 6.2 and MacOS X 10.3 support. Relaxed or precised some
other requirements.
--------+
README | 36 ++++++++++++++++++++++--------------
1 files changed, 22 insertions(+), 14 deletions(-)
Index: carob/README
diff -u carob/README:1.1 carob/README:1.2
--- carob/README:1.1 Fri Mar 24 19:25:56 2006
+++ carob/README Wed Feb 7 12:01:53 2007
@@ -6,6 +6,10 @@
ResultSets and all necessary C++ classes can be used transparently and directly
in any C++ enabled application.
+It has been developped and tested on most mainstream linux
+distributions as well as on FreeBSD 6.2 and MacOS X 10.3
+Check the bug tracker for porting issues.
+
Carob and Friends
-----------------
"Carob" is the historical name grouping the C++ API, the ODBC driver and the
@@ -21,13 +25,12 @@
Dependencies
------------
-We tried to have as less dependencies as possible. And it is even possible to
-tweak carob so you will have NO dependency at all (except libstdc++!)...
-But for the general case, you will need:
+We try to have as less dependencies as possible. You need:
+* A good C++98 library
* The GNU MP Bignum Library (GMP) available at http://www.swox.com/gmp/ AND its
C++ interface for BigDecimals support
-* a POSIX thread (pthread) library for thread safety (there is no real thread
in
-carob, just critical sections)
+* a POSIX thread (pthread) library for controller pingers and carob
+object locking (thread safety)
* optionally Apache's logging library for C++ (log4cxx) available at
http://logging.apache.org/log4cxx/ for better logging (it is still possible to
use internal cerr<<-style logging)
@@ -40,22 +43,27 @@
|-- contrib => Basic examples and contributions to carob
| |-- CPP
| `-- PHP
-|-- debian => Everything needed to build a debian package
-|-- doc => Notes for users and developpers
-|-- doxygen => API documentation
-|-- include => Headers
-|-- src => Source files
-`-- test => Test files
+|-- debian => Everything needed to build a debian package
+|-- doc => Notes for users and developpers
+|-- doxygen => API documentation
+|-- include => Headers
+|-- src => Source files
+|-- test => Test files
+\-- make-includes => compile-time options for ports and to tune the build
Compiling
---------
-Gnu C++ compiler is required. We develop with version 4.0 but it should work
with
-3.3.5 or 3.4 with few effort
-To build carob, just type:
+We develop with GCC version 3.3-4.0 but other compilers should work.
+
+To build carob on linux, just type:
> make
And optionally:
> make test && cd test && ./carobTestLauncher
+For other platforms type something like:
+> make OS=freebsd
+Check make-includes/README for details
+
Quick start
-----------
"a good example is better than a long speech"
_______________________________________________
Carob-commits mailing list
[email protected]
https://forge.continuent.org/mailman/listinfo/carob-commits
