# cinnamon

A lightweight vim-like browser written in C, powered by WebKit2GTK-4.1 and GTK3.

## 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 you, the user.

## Supported platforms

Linux, BSD (Windows/Mac are untested, try at your own risk)

## Dependencies

- webkit2gtk-4.1
- gtk3

To install dependencies on Arch-based systems:  
```shell
# pacman -S webkit2gtk-4.1 gtk3
```

On Debian-based systems (including Ubuntu):
```shell
# apt install libwebkit2gtk-4.1-dev libgtk3-dev
```

On Fedora-based systems:
```shell
# dnf install webkit2gtk4.1-devel gtk3-devel
```

## Installation

To install this software, you must compile it from source. Don't worry, it should only take 5 seconds or less even on a low-powered computer. On my M2 MacBook Pro (running Arch Linux ARM), it takes about 0.3 seconds.

```shell
$ git clone https://git.arslaancodes.com/cinnamon-browser.git
$ cd cinnamon-browser
$ cp config.def.h config.h
# make install
```

To change the install directory, use the PREFIX environment variable. For example, to install in /opt/cinnamon/bin: 
```shell
$ export PREFIX=/opt/cinnamon
# make install
```

## Contributing

Generate a patch with `git format-patch HEAD~1` and email to [arslaan@arslaancodes.com](mailto:arslaan@arslaancodes.com) or send to XMPP address [arslaan@im.arslaancodes.com](xmpp:arslaan@im.arslaancodes.com), beginning the subject line with [PATCH cinnamon-browser]

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