aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c9929b1c8ccce95fe7db07f8652fe59b1860b40e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Beaker
Beaker is a lightweight web framework written in C, designed for building simple and efficient web applications. It currently provides handling HTTP requests, routing, serving static files, rendering HTML templates and managing cookies.

## Disclaimer
I request that none of this code, in part or in full, be hosted on GitHub, SourceForge, or any other proprietary platform. This request is made out of respect for both me, the developer and for you, the user.

## Usage
Look at the files in examples for usage

## Installation
```bash
  $ git clone https://git.bwaaa.monster/beaker
  $ cd beaker
  # make install
```

On macOS the default install prefix is `/usr/local/`, because `/usr/lib` is protected by System Integrity Protection.
The install step produces `libbeaker.dylib` and removes any stale `libbeaker.so` from older installs.
You can always override the destination:

```bash
$ make install INSTALL_PREFIX=/some/prefix/
```

## Roadmap
- Write documentation
- Add more robust logging
- Write more examples

## Contribution
Generate a patch with ```git format-patch HEAD~1``` and email to [gabriel@bwaaa.monster](mailto:gabriel@bwaaa.monster), beginning the subject line with [PATCH beaker]

*If you are sending a revised version of a previous patch, please use [PATCH beaker v2, v3, etc].*