This repository has been archived on 2023-02-02. You can view files and clone it, but cannot push or open issues or pull requests.
barkshark-web/README.md

49 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2022-05-07 20:39:18 -04:00
# Barkshark Web
2020-06-08 15:03:54 -04:00
2022-05-07 21:43:24 -04:00
![](barkshark_web/resources/icon-128.png)
2022-05-07 20:39:18 -04:00
Simple Webkit2 GTK web browser with better fediverse integration.
2020-06-11 10:17:07 -04:00
## Installation
### Easy Install
make install
This will grab all the apt deps (If your system uses a different package manager, sorry. I only know apt), create a python venv, install the python deps, and create a desktop file in $HOME/.local/share/applications
For other package managers, install the equivalent packages and run this command
make install-nodeb
### Install Dependencies
2020-06-11 10:17:07 -04:00
PyGObject and WebKit2Gtk are required. To install them on a Debian-based distro via apt:
2021-05-02 14:14:08 -04:00
sudo apt install gir1.2-glib-2.0 gir1.2-gtk-3.0 gir1.2-webkit2-4.0 gir1.2-notify-0.7 python3-gi
python3 -m pip install -r requirements.txt
2020-06-11 10:17:07 -04:00
If you want to install PyGObject via pip, install these dependencies instead:
sudo apt install `cat apt-requirements.txt | xargs`
2020-06-11 10:17:07 -04:00
### Build Webkit Web Extension
2020-06-11 10:17:07 -04:00
make build
2020-06-11 10:17:07 -04:00
## Usage
2022-05-07 20:39:18 -04:00
Run `--help` to see the list of commands to run
2020-06-11 10:17:07 -04:00
2022-05-07 20:39:18 -04:00
python3 -m barkshark_web --help
2020-06-11 10:17:07 -04:00
## TODO
2021-03-09 07:09:24 -05:00
Moved to [Wiki](https://git.barkshark.xyz/izaliamae/pyweb/wiki/Ideas)
2022-05-07 21:30:10 -04:00
## Credits
App icon by [Efi](https://chitter.xyz/users/efi)
Local web pages use [Nunito Sans](https://github.com/googlefonts/NunitoSans)