Skip to content

Commit

Permalink
Update INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wolkykim committed Mar 4, 2015
1 parent a06c731 commit 6820086
Showing 1 changed file with 42 additions and 8 deletions.
50 changes: 42 additions & 8 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
Installing qLibc
================

qLibc supports POSIX-compliant operating systems, including Linux, MacOS X and most of Unix systems. Windows OS is supported with most of features.

## Configure

### Linux and most of Unix systems.

Configure compile option by executing included "configure" script:
Run "configure" command.

```
$ ./configure
Expand Down Expand Up @@ -34,6 +37,17 @@ To see detailed configure options, use `--help` option:
$ ./configure --help
```

### MacOS X and Windows systems

Run "cmake" command.

```
$ cmake .
```

In many systems, CMake needs to be installed separately. qlibc requires CMake version 2.8.12 or above.
Currently, we're focusing on getting the library compiled on those machines using cmake thus it doesn't provide the full configure options as we provide in configure command.

## Compile

Run `make` in your terminal to compile the source code:
Expand All @@ -44,14 +58,13 @@ $ make

## Install

This command will install `qLibc` on your system. By default, the directory prefix is "/usr/local" so it will be installed in `/usr/local/include` and `/usr/local/lib`:
This command will install `qLibc` on your system. By default, the directory prefix is "/usr/local" so header files will be installed into `/usr/local/include` and library files will be installed into `/usr/local/lib`:

```
$ make install
```

This will only install header files and library(archive; static and dynamic) files.
The documentation in the "doc" directory will not be installed, so make a copy of it yourself if you want to keep it.
This will only install header files and library(archive; static and dynamic) files. The document files in the "doc" directory will not be installed, so please make a copy of it by yourself if you want to keep it in the system.

## Uninstall

Expand All @@ -61,10 +74,31 @@ The documentation in the "doc" directory will not be installed, so make a copy o
$ make uninstall
```

## Test
## Examples and Unit Tests.

Analyzing the example code is probably a best starting point to being familiar with qlibc, but please note that the examples were written as simply as possible just to show the sample usages.

As a reminder, example codes and API documents are provided with the package in the "examples" and "doc" directories.

### Run Examples

The examples also can be compiled by running "make" command in the "examples" directory.

```
$ cd examples
$ make
```

If you're using cmake to configure the qlibc package, it will not generate Makefile for codes in examples.

### Run Unit Tests

Sample source and API documents are provided with the package in the "examples" and "doc" directories.
Currently Unit Tests cover only small portion of codes. This part is in-progress area that we're looking for contributors to enrich this area.

The examples also can be compiled by typing "make" command in the "examples" directory.
Unit tests can be compiled and run as following.

Analyzing the example code is probably best starting point, but be aware that the examples were written as simply as possible just to give you straight-forward ideas. So, please refer included API document for more details.
```
$ cd tests
$ make
$ make run
```

0 comments on commit 6820086

Please sign in to comment.