Skip to content

Commit

Permalink
Update README with build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
batterseapower committed Oct 31, 2010
1 parent fdcb562 commit d0520d3
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@ A library exposing a C interface and dependency-free interface to the Mozilla C+

Pulls together:

* A NSPR emulation library (see nspr-emu/README.md)
* A NSPR emulation library (see `nspr-emu/README.md`)
* Code written by Colin Snover to provide a command line interface to the library
* The UCSD library itself from the Mozilla seamonkey source tree

## Building

We have a build system based on CMake, so you will need that installed. That done, simply do this incantation:

cmake .
make
sudo make install

This will install the header file `charsetdetect.h` and the UCSD shared library, which you should link against in your compiler.

## API documentation

The library provides an opaque type of character set detectors:
Expand Down Expand Up @@ -40,7 +50,7 @@ set detector.

## Licensing

The files libcharsetdetect.{cpp,h} are (c) 2010 Colin Snover and released under an MIT license.
The files `libcharsetdetect.{cpp,h}` are (c) 2010 Colin Snover and released under an MIT license.

The UCSD is (c) mozilla.org and tri-licensed under MPL 1.1/GPL 2.0/LGPL 2.1.

Expand Down

0 comments on commit d0520d3

Please sign in to comment.