Skip to content

Commit df98502

Browse files
Update README.md
1 parent 90f8af8 commit df98502

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,43 +17,38 @@ 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)
2927

30-
# Linux installation
28+
# Getting started
3129

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

3632
```
37-
apt install make
33+
docker pull pythongermany/webserv
3834
```
35+
Pull the [docker image](https://hub.docker.com/repository/docker/pythongermany/webserv/general)
3936

4037
```
41-
apt install clang
38+
make docker.build
39+
make docker.run
4240
```
43-
44-
## Compilation
45-
46-
### Native
41+
This will build and run the standalone webserver image
4742

4843
```
49-
make [performance|debug|fsanitize]
44+
make -C docker up
5045
```
46+
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.
5147

52-
### Docker
48+
## Compile with make and clang
5349

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.
5550
```
56-
make -C docker up
51+
make [performance|debug|fsanitize]
5752
```
5853

5954
# Usage

0 commit comments

Comments
 (0)