diff options
| author | Akshay Nair <phenax5@gmail.com> | 2025-04-12 11:58:27 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2025-04-12 11:58:27 +0530 |
| commit | 80496879c86af00b74f82271282cca3efd99d0b3 (patch) | |
| tree | 5354575bdfbd65f089872283fd856b7f8929eae5 /README.md | |
| parent | f3f109cd054888f857d51ca2b37b4123f3134069 (diff) | |
| download | null-browser-80496879c86af00b74f82271282cca3efd99d0b3.tar.gz null-browser-80496879c86af00b74f82271282cca3efd99d0b3.zip | |
Add readme
Diffstat (limited to '')
| -rw-r--r-- | README.md | 52 |
1 files changed, 51 insertions, 1 deletions
@@ -1,4 +1,54 @@ # Null browser [WIP] +A simple, fast web browser based on qtwebengine with a lua runtime. -A web browser with the simplest subset of features +## What does it do? +This web browser is just a stack of web views that can be controlled using lua. +Don't expect a full featured browser, expect the opposite. + +## What does it not do? How can I do it? +- **No url bar** + - use dmenu, rofi, fzf in a terminal, etc. for url input +- **No tab ui** + - use dmenu, rofi, etc. to show a list of tabs on key + - use tabbed (x11) with multiple windows + - use window manager with multiple windows +- **No persistant history** + - save it in a file on UrlChanged event and show as completion for your url input + - same as above but in a sqlite db instead +- **No splits** + - use window manager + - use [tabbed (X11)](https://tools.suckless.org/tabbed/) +- **No buttons** + - define key bindings +- **No built-in ad blocker** + - filter host-names +- **No settings page** + - write some lua +- **No chrome extensions** + - inject javascript into pages from your lua config +- **No built-in cryptocurrency** + - it's a web browser. Add it if you want it +- **No built-in AI** + - it's a web browser. Add it if you want it + +Any feature you want, you implement yourself. + +## Who is it for? +I built this for myself and people like me who enjoy tinkering with their tools. +Out of the box, it is almost unusable... by design. + +## Install +### Nix flake +- Add this repo to nixos flake config: `inputs.null-browser.url = "github:phenax/null-browser";` +- Or build it in a directory: `nix build github:phenax/null-browser` +- Or run it without installing: `nix run github:phenax/null-browser` +- Or add to profile: `nix profile install github:phenax/null-browser` + +### Others +- Clone +- Run `make build` to build it +- `sudo make install PREFIX=/usr/local` to install it + +## Configuring +WIP |