aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e00a1684c75601966f3df43918cc877f161e96b7 (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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# cinnamon

A lightweight suckless-inspired 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

**Notice:** On some systems, you may need GStreamer plugins (e.g. gst-plugins-pulse/gst-plugins-pipewire) for some websites to work. Please refer to the correct packages based on your distro.

- webkit2gtk-4.1
- gtk3
- clang

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

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

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

On Gentoo-based systems:
```shell
# emerge net-libs/webkit-gtk:4.1 x11-libs/gtk+:3 llvm-core/clang
```

## 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. Well, unless you're on Gentoo, because you'd have to compile the dependency WebKit2GTK-4.1 from source. Good luck, you'll need it lmao.

```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 [[email protected]](mailto:[email protected]) or send to XMPP address [[email protected]](xmpp:[email protected]), 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].*