Warning, /network/angelfish/README.md is written in an unsupported language. File is not indexed.

0001 # Angelfish
0002 
0003 This is a webbrowser designed to
0004 
0005 - be used on small mobile devices,
0006 - integrate well in Plasma workspaces
0007 
0008 <a href='https://flathub.org/apps/details/org.kde.angelfish'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
0009 
0010 ## Reporting bugs
0011 
0012 Bugtracker: https://bugs.kde.org/describecomponents.cgi?product=angelfish
0013 
0014 ## Preliminary roadmap:
0015 - [x] browser navigation: back + forward + reload
0016 - [x] browser status
0017 - [x] Implement URL bar
0018 - [x] Error handler in UI
0019 - [x] history store, model and UI
0020 - [x] bookmarks store, model and UI
0021   - [x] add / remove
0022 - [x] in-window navigation: tabs in bottom bar
0023 - [ ] SSL error handler
0024 - [x] Touch actions (pinch?) (done in QtWebEngine)
0025 - [x] user-agent to request mobile site
0026 - [x] open and close new tabs
0027 - [x] History based completion
0028 - [x] Right click / long press menu
0029 - [x] purpose integration (for kdeconnect)
0030 - [x] adblock
0031 
0032 ## Development
0033 
0034 ### Building
0035 
0036 If you are using a rolling release distribution, you can install the dependencies using your package manager.
0037 Otherwise, use kdesrc-build to build angelfish and its dependencies. Setting up kdesrc-build is documented in the [Community Wiki](https://community.kde.org/Get_Involved/development#Set_up_kdesrc-build)
0038 
0039 Currently the dependencies are:
0040  * Qt (including QtCore, QtQuick, QtTest, QtGui, QtSvg, QtQuickControls2, QtSql and optionally QtFeedback)
0041  * The KDE Frameworks (including Kirigami2, Purpose, I18n, Config, CoreAddons, DBusAddons, WindowSystem, Notifications)
0042  * Rust (including cargo and rustc) (optional)
0043  * [Corrosion](https://github.com/corrosion-rs/corrosion) (optional)
0044 
0045 Please check the community wiki for how to build projects with kdesrc-build.
0046 If you went for using your distribution's package manager, then you can build (and install) Angelfish like this:
0047 ```
0048 mkdir build
0049 cd build
0050 cmake .. # add -DCMAKE_BUILD_TYPE=Release to compile for release
0051 make
0052 sudo make install # optional, if you want to install Angelfish into your system
0053 ```
0054 
0055 ### Adblock
0056 To debug requests sent by the browser, for example for debugging the ad blocker, it can be useful to have a look at the development tools.
0057 For using them, the browser needs to be started with a special environment variable set: `QTWEBENGINE_REMOTE_DEBUGGING=4321 angelfish`.
0058 The variable contains the port on which the development tools will be available. You can now point another browser to http://localhost:4321.
0059 
0060 To enable adblock logging, add the following to `~/.config/QtProject/qtlogging.ini`:
0061 ```
0062 [Rules]
0063 org.kde.angelfish.adblock.debug=true
0064 ```
0065 
0066 ### Flatpak
0067 If one of the Cargo.toml files is updated, the flatpak sources need to be regenerated. That can be done using the `./flatpak/regenerate-sources.sh` script.