|
1 |
| -## <img src="res/xupric.png" width=20> Xupric |
2 |
| -__Screw it, imma work a bit more aka it's horrible:D\ |
3 |
| -Couldn't even last 3 days.__ |
| 1 | +## <img src="res/xupric.png" width=18> Xupric |
4 | 2 |
|
5 |
| -A Modern Web Browser based on webkit2gtk.\ |
6 |
| -Moderately inspired by surf. |
| 3 | +Xupric is a fully functional Web browser.\ |
| 4 | +The features and look was inspired by surf, Firefox and DuckDuckGo's Privacy Browser.\ |
| 5 | +It's goal was to implement all the features you'd expect from a today's browser,\ |
| 6 | +while keeping a nice, dark, non-GTK look, to go along with any wm.\ |
| 7 | +It was written from scratch and isn't a fork. |
7 | 8 |
|
8 | 9 | ### Features
|
9 | 10 | * Functional web searching
|
10 | 11 | * Tabs support (10 static tabs)
|
11 |
| -* Configuration through ~/.config/xupric/xupric.conf |
12 |
| -* CSS styling in ~/.config/xupric/styles/ |
13 |
| -* Dark mode (disabled by default) |
14 |
| -* Shortcut keys |
15 |
| -* Custom Menu & Navigation Bar |
| 12 | +* Custom GTK ui |
| 13 | +* Dark mode |
| 14 | +* Workspaces (max 5) |
| 15 | +* Url filtering like clearURLs |
| 16 | +* a Ton of Shortcut keys |
16 | 17 | * Bookmarks, history, cookies
|
| 18 | +* Configuration through ~/.config/xupric/xupric.conf |
| 19 | +* Custom css/js/certs in ~/.config/xupric/ |
17 | 20 | * & much more
|
18 | 21 |
|
19 | 22 | ### Dependencies
|
20 | 23 | * <a href="https://github.com/libconfuse/libconfuse">confuse</a> \<required\>
|
21 | 24 | * webkit2gtk-4.0 \<required\>
|
22 |
| -* <a href="https://www.nerdfonts.com/font-downloads">JetBrainsMono Nerd Font</a> \<very recommended\> |
23 |
| -* <a href="https://github.com/cbrnix/Flatery">Flatery-Dark icon theme</a> \<very recommended\> |
24 | 25 | * jansson \<required\>
|
25 | 26 | * pcre \<required\>
|
26 | 27 | * xxd \<required\>
|
27 | 28 | * sqlite3 \<required\>
|
28 | 29 | * meson \<required\>
|
29 | 30 | * x11 \<required\>
|
30 | 31 | * gtk3 \<required\>
|
| 32 | +* <a href="https://www.nerdfonts.com/font-downloads">JetBrainsMono Nerd Font</a> \<very recommended\> |
| 33 | +* <a href="https://github.com/cbrnix/Flatery">Flatery-Dark icon theme</a> \<very recommended\> |
31 | 34 |
|
32 |
| -NB! Gtk4 and webkit2gtk-5.0 __aren't__ supported. |
| 35 | +__Without the nerd font, the browser looks very weird.__\ |
| 36 | +Gtk4 and webkit2gtk-5.0 __aren't__ supported. |
33 | 37 |
|
34 | 38 | ### Install
|
35 | 39 | ```sh
|
| 40 | +> git clone https://github.com/chm46e/xupric |
| 41 | +> cd xupric |
36 | 42 | > mkdir build && cd build
|
37 | 43 | > meson ..
|
38 | 44 | > ninja
|
39 | 45 | > sudo ninja install
|
40 | 46 | ```
|
| 47 | +__NB! Have a look at the man page!__ ```man xupric```\ |
| 48 | +It goes over everything (shortcuts, features, etc). |
41 | 49 |
|
42 | 50 | ### Showcase
|
43 | 51 | <img src="res/previews/xupric_start.png">
|
44 |
| -<img src="res/previews/xupric_menu.png"> |
45 | 52 | <img src="res/previews/xupric_wiki.png">
|
46 |
| - |
47 |
| -### Keyboard Shortcuts |
48 |
| -| KEY | Action | |
49 |
| -| ------ | ----- | |
50 |
| -| alt+q | quit | |
51 |
| -| ctrl+r | reload | |
52 |
| -| ctrl+shift+r | reload -cache | |
53 |
| -| F5 | reload | |
54 |
| -| ctrl+f | start find | |
55 |
| -| ctrl+n | find next | |
56 |
| -| ctrl+shift+n | find previous | |
57 |
| -| ctrl+b | bookmark toggle | |
58 |
| -| ctrl+d | dark mode toggle | |
59 |
| -| ctrl+shift+d | debug toggle | |
60 |
| -| ctrl+s | download page | |
61 |
| -| alt+s | uri entry focus | |
62 |
| -| alt+shift+s | uri secondary entry focus| |
63 |
| -| alt+w | open new window | |
64 |
| -| Esc | stop (uri,find,fullscreen)| |
65 |
| -| F11 | fullscreen toggle| |
66 |
| -| alt+f | fullscreen toggle| |
67 |
| -| alt+h | goto home/start | |
68 |
| -| alt+Left | go backwards | |
69 |
| -| alt+Right | go forwards | |
70 |
| -| ctrl+equal | zoom in | |
71 |
| -| ctrl+minus | zoom out | |
72 |
| -| ctrl+0 | zoom reset | |
73 |
| -| ctrl+Tab | next tab | |
74 |
| -| ctrl+shift_Tab | previous tab | |
75 |
| -| alt+(1-0) | switch to tab (1-0)| |
76 |
| -| ctrl+i | toggle webinspector| |
77 |
| -| C+S+A+a | load amazon.com | |
78 |
| -| C+S+A+d | load discord.com | |
79 |
| -| C+S+A+e | load ebay.com | |
80 |
| -| C+S+A+g | load github.com | |
81 |
| -| C+S+A+i | load twitter.com | |
82 |
| -| C+S+A+m | load mail.zoho.com| |
83 |
| -| C+S+A+n | load netflix.com | |
84 |
| -| C+S+A+o | load odysee.com | |
85 |
| -| C+S+A+r | load reddit.com | |
86 |
| -| C+S+A+t | load trello.com | |
87 |
| -| C+S+A+w | load wikipedia.org| |
88 |
| -| C+S+A+y | load youtube.com | |
89 |
| -| C+S+A+(1-5) | switch to workspace (1-5)| |
90 |
| - |
91 |
| -Tab (10 max) switching is done with alt+(tab_number from 1->0) |
92 |
| - |
93 |
| -### Configuration |
94 |
| -Most of the configuration is done through ~/.config/xupric/xupric.conf.\ |
95 |
| -And the styles are in ~/.config/xupric/styles/ |
| 53 | +<img src="res/previews/xupric_menu.png"> |
96 | 54 |
|
97 | 55 | ### Credits
|
98 | 56 | Thank you, <a href="https://github.com/Tux-Code">Tux-Code</a> for creating the logos.
|
99 | 57 |
|
100 | 58 | ### Notes
|
101 | 59 | The default xupric is styled using the <a href="https://github.com/ChrisKempson/Tomorrow-Theme">Tomorrow Night</a> color theme.\
|
102 |
| -The cache is stored in ~/.cache/xupric/\ |
| 60 | +The configuration stuff is stored in ~/.config/xupric/\ |
103 | 61 | Almost all the files/dirs get generated during run-time.\
|
104 | 62 | The coding style is somewhat a lazy Linux kernel like.\
|
105 |
| -My intention was to make it not look like a gtk application.\ |
| 63 | +Again, have a look at xupric's man page:D\ |
106 | 64 | There are a ton of bugs, so hold your teddy bear.
|
0 commit comments