Added more detailed dependency installation instructions as suggested in https://github.com/openjournals/joss-reviews/issues/1592#issuecomment-515789575
This commit is contained in:
parent
dcc6090678
commit
99d14cf841
5 changed files with 38 additions and 14 deletions
21
README.md
21
README.md
|
|
@ -1,11 +1,10 @@
|
|||
Simple-Web-Server
|
||||
=================
|
||||
# Simple-Web-Server
|
||||
|
||||
A very simple, fast, multithreaded, platform independent HTTP and HTTPS server and client library implemented using C++11 and Asio (both Boost.Asio and standalone Asio can be used). Created to be an easy way to make REST resources available from C++ applications.
|
||||
|
||||
See https://gitlab.com/eidheim/Simple-WebSocket-Server for an easy way to make WebSocket/WebSocket Secure endpoints in C++. Also, feel free to check out the new C++ IDE supporting C++11/14/17: https://gitlab.com/cppit/jucipp.
|
||||
|
||||
### Features
|
||||
## Features
|
||||
|
||||
* Asynchronous request handling
|
||||
* Thread pool if needed
|
||||
|
|
@ -18,7 +17,7 @@ See https://gitlab.com/eidheim/Simple-WebSocket-Server for an easy way to make W
|
|||
* Sending outgoing messages is thread safe
|
||||
* Client creates necessary connections and perform reconnects when needed
|
||||
|
||||
### Usage
|
||||
## Usage
|
||||
|
||||
See [http_examples.cpp](https://gitlab.com/eidheim/Simple-Web-Server/blob/master/http_examples.cpp) or
|
||||
[https_examples.cpp](https://gitlab.com/eidheim/Simple-Web-Server/blob/master/https_examples.cpp) for example usage.
|
||||
|
|
@ -26,13 +25,15 @@ Particularly, the JSON-POST (using Boost.PropertyTree) and the GET /match/[numbe
|
|||
|
||||
[Documentation](https://eidheim.gitlab.io/Simple-Web-Server/annotated.html) is also available, generated from the master branch.
|
||||
|
||||
### Dependencies
|
||||
## Dependencies
|
||||
|
||||
* Boost.Asio or standalone Asio
|
||||
* Boost is required to compile the examples
|
||||
* For HTTPS: OpenSSL libraries
|
||||
* For HTTPS: OpenSSL libraries
|
||||
|
||||
### Compile and run
|
||||
See [dependency installation instructions](https://gitlab.com/eidheim/Simple-Web-Server/blob/master/docs/dependency_install.md) for further information.
|
||||
|
||||
## Compile and run
|
||||
|
||||
Compile with a C++11 compliant compiler:
|
||||
```sh
|
||||
|
|
@ -43,13 +44,13 @@ make
|
|||
cd ..
|
||||
```
|
||||
|
||||
#### HTTP
|
||||
### HTTP
|
||||
|
||||
Run the server and client examples: `./build/http_examples`
|
||||
|
||||
Direct your favorite browser to for instance http://localhost:8080/
|
||||
|
||||
#### HTTPS
|
||||
### HTTPS
|
||||
|
||||
Before running the server, an RSA private key (server.key) and an SSL certificate (server.crt) must be created.
|
||||
|
||||
|
|
@ -57,7 +58,7 @@ Run the server and client examples: `./build/https_examples`
|
|||
|
||||
Direct your favorite browser to for instance https://localhost:8080/
|
||||
|
||||
### Contributing
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome, either by creating an issue or a merge request.
|
||||
However, before you create a new issue or merge request, please search for previous similar issues or requests.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue