Commit 8d37b2ff authored by Bryton Lacquement's avatar Bryton Lacquement 🚪

Add installation guide

parent c7fa14b2
# Cython wrapper for the LWAN HTTP server
This project is a proof of concept which aims at making an efficient multi-threaded Python server. [LWAN](https://lwan.ws/), written in C, is running under the hood. [Cython](http://cython.org/) is used to wrap it into a Python module.
## Usage
### Prerequisites
LWAN must be installed on your machine as a library. To do so, you can either follow [the instructions](https://github.com/lpereira/lwan#build-commands) from the LWAN repository or run `install_lwan.sh` if you are feeling lazy. In any case, make sure to have the required dependencies installed before.
Then, install Cython using pip:
```shell
pip3 install cython
```
### Compile and run
A simple Makefile automates the building and running part:
```shell
make
make run
```
Your server should be listening on `0.0.0.0:8080`.
#!/bin/bash
# This simple script automates the installation of LWAN (https://lwan.ws/), as
# described here: https://github.com/lpereira/lwan/blob/master/README.md#build-commands .
# This will install LWAN in release mode.
#
# Warning: Make sure to have the required dependencies installed before running
# it (i.e. https://github.com/lpereira/lwan#minimum-to-build).
git clone git://github.com/lpereira/lwan
cd lwan
mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make
sudo make install
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment