Skip to content

Commit

Permalink
Completed README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Altaks committed Feb 4, 2024
1 parent 298eee5 commit cd2ec2e
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,37 @@
# HTTPServer

A simple HTTP server written in C
A simple HTTP server written in C with the least amount of libs (event system libs) as a challenge to myself.

Made in one week, it has no tests because I didn't have time to write them.

## Installation

To install the server, you need to clone the repository and compile the source code.

I use CMake & Ninja to compile the source code, so you need to have it installed or create a Makefile yourself.

## Usage

To start the server run the following command:

```bash
<executable> <port> <content-folder>
```

Example :

```bash
./server 8080 /home/user/Downloads
```

## Contributing

Pull requests are welcome.

For major changes, please open an issue first to discuss what you would like to change.

## Contact me

Email: [email protected]

Discord : altakxs

0 comments on commit cd2ec2e

Please sign in to comment.