From df985024576a2353ea74662957b2932de7c2225f Mon Sep 17 00:00:00 2001 From: PythonGermany <97847597+PythonGermany@users.noreply.github.com> Date: Sat, 26 Oct 2024 02:56:48 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 0f5806a..14b58e0 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,7 @@ This project is a basic HTTP server written in C++98. The standards listed below # Table of Contents -- [Linux installation](#linux-installation) - - [Requirements](#requirements) - - [Compilation](#compilation) +- [Getting started](#getting-started) - [Usage](#usage) - [Flags](#flags) - [Configuration](#configuration) @@ -27,33 +25,30 @@ This project is a basic HTTP server written in C++98. The standards listed below - [Directives](#directives) - [Example](#example) -# Linux installation +# Getting started -## Requirements - -[Docker](https://docs.docker.com/engine/install/) or +## Docker ``` -apt install make +docker pull pythongermany/webserv ``` +Pull the [docker image](https://hub.docker.com/repository/docker/pythongermany/webserv/general) ``` -apt install clang +make docker.build +make docker.run ``` - -## Compilation - -### Native +This will build and run the standalone webserver image ``` -make [performance|debug|fsanitize] +make -C docker up ``` +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. -### Docker +## Compile with make and clang -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. ``` -make -C docker up +make [performance|debug|fsanitize] ``` # Usage From 685b46516c6ef4238152d1adba559527979ce294 Mon Sep 17 00:00:00 2001 From: PythonGermany <97847597+PythonGermany@users.noreply.github.com> Date: Sat, 26 Oct 2024 03:00:53 +0200 Subject: [PATCH 2/2] Add contributor section to README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 14b58e0..e6f123b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ This project is a basic HTTP server written in C++98. The standards listed below - [Contexts](#contexts) - [Directives](#directives) - [Example](#example) +- [Contributors](#contributors) # Getting started @@ -364,3 +365,8 @@ server { ``` ./webserv [-i] ``` + +# Contributors + +[jharrach](https://github.com/jharrach) +[PythonGermany](https://github.com/PythonGermany)