diff --git a/README.md b/README.md index 0f5806a..e6f123b 100644 --- a/README.md +++ b/README.md @@ -17,43 +17,39 @@ 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) - [Contexts](#contexts) - [Directives](#directives) - [Example](#example) +- [Contributors](#contributors) -# 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 @@ -369,3 +365,8 @@ server { ``` ./webserv [-i] ``` + +# Contributors + +[jharrach](https://github.com/jharrach) +[PythonGermany](https://github.com/PythonGermany)