You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
# Easysock
|
|
## An easy-to-use C socket library
|
|
|
|
*Easysock* is a single-file, easy-to-use socket library, that can be used for network programming in C. It has no dependencies other than the C standard library.
|
|
___
|
|
### Compiling
|
|
The library can be compiled using the provided Makefile.
|
|
|
|
```
|
|
make
|
|
```
|
|
|
|
There are a few optional targets, which enable specific functionality.
|
|
|
|
`allwarn - enable all warnings`
|
|
`debug - compile with 'debug' flag`
|
|
`static - compile as statically linked library - NOT IMPLEMENTED`
|
|
|
|
<br />
|
|
<br />
|
|
|
|
They can be used as follows:
|
|
|
|
`make [TARGET NAME]`
|
|
___
|
|
### Installation
|
|
The library can also be installed using the provided Mekfile.
|
|
```
|
|
make install
|
|
```
|
|
The `install` target supports two environment variables. `DESTDIR`, which specifies the installation directory, and `PREFIX` which specifies the installation prefix. They are used as follows:
|
|
|
|
`DESTDIR=/home/user PREFIX=/usr/local make install`
|
|
|
|
This will install the library file in `/home/user/usr/local/lib` and the header file in `/home/user/usr/local/include`.
|
|
___
|
|
### Usage
|
|
To use the library, simply include the header file:
|
|
```
|
|
#include <easysock.h>
|
|
...
|
|
```
|
|
and link the library:
|
|
` gcc example.c -o example -leasysock`
|
|
___
|
|
|
|
This file was written using [Dillinger](https://dillinger.io).
|