Skip to content

Commit 9b22243

Browse files
Merge pull request #29 from PythonGermany/PythonGermany-patch-1
Update README.md
2 parents 90f8af8 + 685b465 commit 9b22243

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,43 +17,39 @@ This project is a basic HTTP server written in C++98. The standards listed below
1717

1818
# Table of Contents
1919

20-
- [Linux installation](#linux-installation)
21-
- [Requirements](#requirements)
22-
- [Compilation](#compilation)
20+
- [Getting started](#getting-started)
2321
- [Usage](#usage)
2422
- [Flags](#flags)
2523
- [Configuration](#configuration)
2624
- [Contexts](#contexts)
2725
- [Directives](#directives)
2826
- [Example](#example)
27+
- [Contributors](#contributors)
2928

30-
# Linux installation
29+
# Getting started
3130

32-
## Requirements
33-
34-
[Docker](https://docs.docker.com/engine/install/) or
31+
## Docker
3532

3633
```
37-
apt install make
34+
docker pull pythongermany/webserv
3835
```
36+
Pull the [docker image](https://hub.docker.com/repository/docker/pythongermany/webserv/general)
3937

4038
```
41-
apt install clang
39+
make docker.build
40+
make docker.run
4241
```
43-
44-
## Compilation
45-
46-
### Native
42+
This will build and run the standalone webserver image
4743

4844
```
49-
make [performance|debug|fsanitize]
45+
make -C docker up
5046
```
47+
This will create a mariadb docker container for the database another container which will setup wordpress, compile webserv execute it. To populate the container env credentials you can make a copy of the [.env-example](docker/.env-example) file and rename it to `.env`, make sure to change the default values according to your needs.
5148

52-
### Docker
49+
## Compile with make and clang
5350

54-
This will create a mariadb docker container for the database another container which will setup wordpress, compile webserv execute it. To populate the container env credentials you can make a copy of the [.env-example](docker/.env-example) file and rename it to `.env`, make sure to change the default values according to your needs.
5551
```
56-
make -C docker up
52+
make [performance|debug|fsanitize]
5753
```
5854

5955
# Usage
@@ -369,3 +365,8 @@ server {
369365
```
370366
./webserv [-i]
371367
```
368+
369+
# Contributors
370+
371+
[jharrach](https://github.com/jharrach)
372+
[PythonGermany](https://github.com/PythonGermany)

0 commit comments

Comments
 (0)