Skip to content

Commit 192943d

Browse files
committed
Create INSTALL.md
1 parent 51d580a commit 192943d

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

INSTALL.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Installing qDecoder
2+
3+
## Get qDecoder Package
4+
5+
The latest version of qDecoder can be found at https://github.com/wolkykim/qdecoder
6+
7+
## Configure
8+
9+
Configure compile option by executing included "configure" script.
10+
11+
```
12+
$ ./configure
13+
```
14+
15+
qDecoder can be FastCGI enabled at the compile time, use --enable-fastcgi option and put the directory path where the "fcgi_stdio.h" is located.
16+
17+
```
18+
$ ./configure --enable-fastcgi=/usr/local/include
19+
```
20+
21+
By default qDecoder will be install on /usr/local/{include,lib}, so use --prefix option if you want to change the installation path.
22+
23+
```
24+
$ ./configure --prefix=/usr/local/qdecoder
25+
```
26+
27+
To see detailed configure options, use --help option.
28+
29+
```
30+
$ ./configure --help
31+
```
32+
33+
## Compile
34+
35+
Type make to compile the source codes.
36+
37+
```
38+
$ make
39+
```
40+
41+
## Install
42+
43+
This command will install qDecoder on your system. By default, the directory prefix is "/usr/local" so it will be install on /usr/local/include and /usr/local/lib.
44+
45+
```
46+
$ make install
47+
```
48+
49+
This will only install header files and library(archive; static and dynamic) files.
50+
The Examples and Documentations will not be installed, so make a copy of it by yourself if you want to keep it.
51+
52+
## Uninstall
53+
54+
qDecoder can be completely removed from the system.
55+
56+
```
57+
$ make uninstall
58+
```
59+
60+
## Test
61+
62+
Sample sources and API document are provided with the package in the "examples" and "doc" directories.
63+
64+
The examples also can be compiled by typing "make" command in the "examples" directory.
65+
And "index.html" file is provided for your tests.
66+
67+
Analyzing the example codes is probably best starting point.
68+
But be aware that the examples were written as simple as it can be just to give you straight-forward ideas, so please refer included API document for more details.

0 commit comments

Comments
 (0)