From 6bf5766469b037c5ec695492218ddebecd3d54ed Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Sat, 14 Jan 2017 17:06:29 +0100 Subject: Added Readme Changed name of application --- BUILDING.md | 23 +++++++++++++++++------ CONTRIBUTING.md | 14 ++++++++++++++ README.md | 14 ++++++++++++++ src/main.cpp | 2 +- src/qt-simplebrowser.pro | 30 ------------------------------ src/smolbote.pro | 30 ++++++++++++++++++++++++++++++ test/poi.profile | 1 + 7 files changed, 77 insertions(+), 37 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 README.md delete mode 100644 src/qt-simplebrowser.pro create mode 100644 src/smolbote.pro create mode 100644 test/poi.profile diff --git a/BUILDING.md b/BUILDING.md index bc02867..aa693dd 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,18 +1,29 @@ -### How to build +## Building +* (Recommended) Create a build folder and change into it ``` mkdir build && cd build -qmake-qt5 ../src/qt-simplebrowser.pro +``` + +* Generate the Makefile +``` +qmake-qt5 ../src/smolbote.pro + +* [TODO] Prepare translations + +* Run make +``` make ``` -## Notes +### Notes +* Don't do any steps marked [TODO] * Windows: MSVC compiler is required because of QtWebEngine dependency * Windows: Passing the -v or -h parameters creates a dialog box instead of writing the output to stdout. This is Qt behaviour. -### Deploying +## Deploying -## Tarball +### Tarball Creating a tarball: ``` @@ -39,7 +50,7 @@ Verifying checksum: sha512sum --check checksum.sha512 ``` -## Windows +### Windows ``` QT_DIR\QT_VERSION\msvc2015_64\windeployqt.exe build-PROFILE\release\qtbrowser.exe diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..09b059f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +## Folder structure + +/src | source code +/src/widgets | subclassed Qt widgets +/src/forms | Qt UI forms and classes +/src/webengine | QWebEngine* subclasses +/test | test run location, mainly for QtCreator + +## Code style + +## Testing + +### firejail +Any submitted modifications must work with the provided firejail profile. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b4f5d55 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +## *smolbote* +_yet another Qute browser_ + +### What is this and why should I care? +It is supposed to be: + +* minimal - without any additions outside its main purpose +* user-centric - with accessible and easy-to-edit configuration + +### What's up with the name?! +It's a small boat. + +### Sounds dumb, how do I use it? +You make it yourself after taking a cursory glance at BUILDING.md. diff --git a/src/main.cpp b/src/main.cpp index a0ec78f..835bbbf 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -6,7 +6,7 @@ int main(int argc, char *argv[]) { QApplication app(argc, argv); - app.setApplicationName("qtwebenginebrowser"); + app.setApplicationName("smolbote"); app.setApplicationVersion("0.0.0"); QCommandLineParser parser; diff --git a/src/qt-simplebrowser.pro b/src/qt-simplebrowser.pro deleted file mode 100644 index b4c98aa..0000000 --- a/src/qt-simplebrowser.pro +++ /dev/null @@ -1,30 +0,0 @@ -#------------------------------------------------- -# -# -# -#------------------------------------------------- - -QT += core gui widgets \ - webengine webenginewidgets - -TARGET = qtbrowser -TEMPLATE = app - - -SOURCES += main.cpp \ - mainwindow.cpp \ - browser.cpp \ - widgets/webviewtabbar.cpp \ - settings.cpp \ - forms/profiledialog.cpp \ - webengine/webengineprofile.cpp - -HEADERS += mainwindow.h \ - browser.h \ - widgets/webviewtabbar.h \ - settings.h \ - forms/profiledialog.h \ - webengine/webengineprofile.h - -FORMS += mainwindow.ui \ - forms/profiledialog.ui diff --git a/src/smolbote.pro b/src/smolbote.pro new file mode 100644 index 0000000..d2eaa8c --- /dev/null +++ b/src/smolbote.pro @@ -0,0 +1,30 @@ +#------------------------------------------------- +# +# +# +#------------------------------------------------- + +QT += core gui widgets \ + webengine webenginewidgets + +TARGET = poi +TEMPLATE = app + + +SOURCES += main.cpp \ + mainwindow.cpp \ + browser.cpp \ + widgets/webviewtabbar.cpp \ + settings.cpp \ + forms/profiledialog.cpp \ + webengine/webengineprofile.cpp + +HEADERS += mainwindow.h \ + browser.h \ + widgets/webviewtabbar.h \ + settings.h \ + forms/profiledialog.h \ + webengine/webengineprofile.h + +FORMS += mainwindow.ui \ + forms/profiledialog.ui diff --git a/test/poi.profile b/test/poi.profile new file mode 100644 index 0000000..6a68fce --- /dev/null +++ b/test/poi.profile @@ -0,0 +1 @@ +################################
# Generic GUI application profile
################################
include /etc/firejail/disable-common.inc
include /etc/firejail/disable-programs.inc
include /etc/firejail/disable-passwdmgr.inc

#blacklist ${HOME}/.wine

caps.drop all
#netfilter
nonewprivs
noroot
protocol unix,inet,inet6
seccomp -- cgit v1.2.1