aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArslaan Pathan <[email protected]>2026-03-26 11:46:32 +1300
committerArslaan Pathan <[email protected]>2026-03-26 11:46:32 +1300
commit97271a5c2c9ab7e475e531a9d94a0506c10783ec (patch)
tree90121ff6e589ffd9fa84d36dc6a257fc848a92cd
parent98220f6c7633bf2d58bca816f0fa7b3827017261 (diff)
downloadcinnamon-browser-97271a5c2c9ab7e475e531a9d94a0506c10783ec.tar.xz
cinnamon-browser-97271a5c2c9ab7e475e531a9d94a0506c10783ec.zip
README
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5835813
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# 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 (GTK is not supported on Windows/Mac)
+
+## 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`