diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 32 insertions, 5 deletions
@@ -8,13 +8,40 @@ I request that none of this code, in part or in full, be hosted on GitHub, Sourc ## Supported platforms -Linux/BSD (GTK is not supported on Windows/Mac) +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. -1. Clone the source code: `git clone https://git.arslaancodes.com/cinnamon-browser.git` -2. Enter the source code directory: `cd cinnamon-browser` -3. Compile the source code: `make all` -4. Copy the binary to /usr/bin (run as root): `cp ./cinnamon /usr/bin/cinnamon` +```shell +$ git clone https://git.arslaancodes.com/cinnamon-browser.git +$ cd cinnamon-browser +# 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 +``` |