aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 29e5dc06ad3aed80ae02e1c6ba26ffdd8be00202 (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
                              __                __
       ____  ___  __  _____  / /___ _____  ____/ /
      / __ \/ _ \/ / / / _ \/ / __ `/ __ \/ __  / 
     / / / /  __/ /_/ /  __/ / /_/ / / / / /_/ /  
    /_/ /_/\___/\__,_/\___/ /\__,_/_/ /_/\__,_/   
          out of foppery /_/ and whim

## *smolbote?*
_It's yet another no-frills browser, poi!_

## What is this and why should I care?
smolbote is a [keep-it-simple][kiss-principle] free software web browser.

This program is free software. You can use it as you see fit, study and modify
the source code, and share the program with or without modification, while
providing the same terms.

For more information and a list of dependancies, see [LICENSE.md][repo-license].

#### Simplicity
This should be a simple browser that only does its browsing job with as little
fuss as possible. This is not a platform.

#### Customizability
This browser should be usable out of the box, with minimal if any configuration
necessary. All functionality should be user-customizable, and it is the user's
responsibility to ensure a stable working state when changing settings.

## What's up with the name?!
It's a small boat. It says poi.

## Sounds dumb, how do I use it?

### Nightly builds

### Building from source

Required dependencies
- latest stable [Qt](https://www.qt.io/)
- latest stable [meson](https://mesonbuild.com/)
- A compiler with C++2a support

```
# clone
git clone git://neueland.iserlohn-fortress.net/smolbote

# configure
mkdir build
meson build

# make
ninja -C build
```

## It doesn't work, what now?
Drop me an email at _aqua at iserlohn dash fortress dot net_.

[kiss-principle]: https://en.wikipedia.org/wiki/KISS_principle
[repo-license]: https://neueland.iserlohn-fortress.net/cgit/smolbote/tree/LICENSE.md