Skip to content

Commit 501ae4b

Browse files
committed
Update the README
1 parent 5a23fa1 commit 501ae4b

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
[![Build status](https://travis-ci.org/kennknowles/ocaml-freetds.png)](https://travis-ci.org/kennknowles/ocaml-freetds)
2+
13
OCaml FreeTDS Binding
24
=====================
35

46
https://github.com/kennknowles/ocaml-freetds
57

6-
[![Build status](https://travis-ci.org/kennknowles/ocaml-freetds.png)](https://travis-ci.org/kennknowles/ocaml-freetds)
7-
88
An OCaml binding to the `ct-lib` portion of the `freetds` library, for interfacing with Sybase and Microsoft SQL databases.
99

1010

@@ -14,6 +14,9 @@ Feature Summary
1414
- Direct binding to the `ct-lib` interface
1515
- Supports `Dbi_freetds` module included with `ocamldbi`
1616

17+
See the [online
18+
documentation](https://kennknowles.github.io/ocaml-freetds/doc).
19+
1720

1821
Known Bugs And Limitations
1922
--------------------------
@@ -29,6 +32,10 @@ Known Bugs And Limitations
2932
Installation
3033
------------
3134

35+
The easier way is to use opam:
36+
37+
opam install freetds
38+
3239
Quick Version:
3340

3441
```
@@ -41,17 +48,15 @@ $ make install
4148
Long Version:
4249

4350
1) `make`
44-
This will build ocaml-freetds according to your ./configure instructions.
51+
This will build ocaml-freetds. This requires FreeTDS development
52+
packages to be installed, see the `depexts` section in
53+
[freetds.opam](freetds.opam).
4554

4655
2) `make install`
4756
You may need to run this as root, or someone with permissions to the findlib's destdir.
4857
This should install ocaml-freetds as a findlib package, so you can use
4958
'ocamlfind' to build things with it.
5059

51-
Other things to build:
52-
53-
- You can also build a toplevel with "make freetds.top"
54-
5560
## Special OSX Instructions
5661

5762
This seems to be the easiest way to get ready on OSX:
@@ -67,15 +72,15 @@ Examples
6772
--------
6873

6974
In the examples subdirectory is a simple SQL dispatcher script written against
70-
the Ct module, and also one for the Dbi_freetds module.
75+
the `Ct` module, and also one for the `Dbi_freetds` module.
7176

7277

7378
Contributors
7479
------------
7580

76-
- [Kenn Knowles](https://github.com/kennknowles) ([@KennKnowles](http://twitter.com/KennKnowles))
77-
- [Christophe Troestler](https://github.com/Chris00)
78-
81+
- [Kenn Knowles](https://github.com/kennknowles) ([@KennKnowles](http://twitter.com/KennKnowles))
82+
- [Christophe Troestler](https://github.com/Chris00)
83+
- [Brendan Long](https://github.com/brendanlong)
7984

8085
License
8186
-------

0 commit comments

Comments
 (0)