diff options
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/manual/Bugs.md | 17 | ||||
| -rw-r--r-- | docs/manual/Building.md | 51 | ||||
| -rw-r--r-- | docs/manual/Contributing.md | 92 | ||||
| -rw-r--r-- | docs/manual/Features.1.0.md | 32 | ||||
| -rw-r--r-- | docs/manual/Quickstart.md | 15 | ||||
| -rw-r--r-- | linux/makepkg/PKGBUILD.generic | 2 |
7 files changed, 3 insertions, 210 deletions
@@ -2,7 +2,7 @@ _It's yet another no-frills browser, poi!_ ### What is this and why should I care? -The aim is to create a [KISS](kiss-principle) free-software web browser. +The aim is to create a [KISS][kiss-principle] free-software web browser. * small: do one thing and do it well * clean: a small codebase of human-readable code @@ -24,6 +24,6 @@ Do you know what a compiler is? Great, glance at docs/manual/Building.md for instructions. ### It doesn't work, what now? -Drop me an email at _aqua at iserlohn-fortress.net_. +Drop me an email at _aqua at iserlohn dash fortress dot net_. [kiss-principle]: https://en.wikipedia.org/wiki/KISS_principle diff --git a/docs/manual/Bugs.md b/docs/manual/Bugs.md deleted file mode 100644 index 8d1b086..0000000 --- a/docs/manual/Bugs.md +++ /dev/null @@ -1,17 +0,0 @@ -# Reporting bugs - -Please include the following when reporting bugs: -* Operating system used -* Version of Qt used, any relevant information if you built it yourself -* Detailed explanation of the bug: - * what was done - * what was expected - * what happened - -An example of a bad bug report is: -> Something happened, and what I pressed the button it broke. - -An exmaple of a good bug report is: -> When I opened the Page menu and pressed Print to PDF, nothing happened. - -Send bug reports to _aqua at iserlohn-fortress.net_. diff --git a/docs/manual/Building.md b/docs/manual/Building.md deleted file mode 100644 index 5eee024..0000000 --- a/docs/manual/Building.md +++ /dev/null @@ -1,51 +0,0 @@ -# Building - -## Dependencies - -### Libraries -- [Qt](https://www.qt.io/) - - an up-to-date version, even thought the codebase should largely work with Qt 5.7 or later - - WebEngine -- [libconfig](https://hyperrealm.github.io/libconfig/) - -### Tools -* A working compiler - - gcc or clang on Linux - - msvc on Windows due to QtWebEngine -* cmake - - minimal version 3.1.0, but please use something up-to-date - -## Compiling -smolbote follows the generic cmake build template. -``` -# generate makefile -cmake -DCMAKE_BUILD_TYPE=Release -G "Unix Makefiles" ../smolbote.git -# build -make -j 4 -# install -make DESTDIR=/install/root/goes/here install -``` - -### Using libc++ -You can use libc++ over stdlibc++ by setting UseLibCpp to On. Requires clang. -> -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DUseLibCpp=On - -## Packaging - -### Source Tarball -``` -# Get source code from the repository -git archive --format=tar HEAD > head.tar -# Compress with lzip -lzip -9 --force --output=head.tar.lz head.tar -# Generate checksum -sha512sum --binary head.tar.lz > head.tar.lz.sha512 -``` - -### makepkg -A PKGBUILD is provided in linux/makepkg/PKGBUILD. Please read before using. - -## Troubleshooting - -### Cannot link libconfig -You don't have pkg-config installed. diff --git a/docs/manual/Contributing.md b/docs/manual/Contributing.md deleted file mode 100644 index c6d1bcd..0000000 --- a/docs/manual/Contributing.md +++ /dev/null @@ -1,92 +0,0 @@ -# Code style - -## Guidelines -* Use generic formats - -## Versioning -- major version: Changed infrequently and almost entirely out of foppery and whim. -- minor version: Milestone of multiple features. -- revision: Major bugfixes and each new feature should get a revision. - -## Qt -* Check pointers with ´´´Q_CHECK_PTR´´´ before using or returning them. -* Avoid using connect SIGNAL and SLOT. Instead use &Class::method. This way, connects are checked during the compile, not at runtime. -* Where possible, use QVector over QList: http://lists.qt-project.org/pipermail/development/2017-March/029040.html - -## clazy -You can use [clazy](https://github.com/KDE/clazy) to check Qt semantics. -Requires clang. - -To set check levels, set the CLAZY_CHECKS environment variable to 'level0,level1', etc. - -### Setting up in qbs -1. Create a profile for clazy -``` -qbs-setup-toolchains --type clang /usr/bin/clazy clazy -qbs-config profiles.clazy.cpp.cCompilerName clang -qbs-config profiles.clazy.cpp.cxxCompilerName clazy -``` -2. Create a profile for qt5-clazy -``` -qbs-setup-qt /usr/bin/qmake-qt5 qt5-clazy -qbs-config profiles.qt5-clazy.baseProfile clazy -``` - -### Setting up in QtCreator -The simplest way to set it up is to use _clazy_ instead of _clang_. - -1. Go to Tools » Options » Build & Run » Compilers -2. Clone the clang compiler of your choice -3. Set _Compiler path_ to _/usr/bin/clazy_ - -This will update the qbs profile that QtCreator uses. - -### Reducing clazy noise -If you want to suppress warnings from headers of Qt or 3rd party code, include -them with -isystem instead of -I. To do this, you have to -[modify your Qt profile](clazy-sysincludes) like this: - -Find the profile's search path: -```sh -$ qbs config --list profiles.qt562.preferences -profiles.qt562.preferences.qbsSearchPaths: "/home/someone/.config/QtProject/qbs/1.9.0/profiles/qt562" -``` - -Replace cpp.includePaths with cpp.systemIncludePaths in the Qt modules of that profile: - -```sh -$ find /home/someone/.config/QtProject/qbs/1.9.0/profiles/qt562/modules/Qt/ -name '*.qbs' | xargs -n1 sed -i s/cpp\.includePaths/cpp.systemIncludePaths/ -``` - -[clazy-sysincludes]: http://lists.qt-project.org/pipermail/qbs/2017-April/001709.html - -# Before you submit - -## Licensing -Smolbote is licensed under GPLv3 _only_. Your code needs to be compatible with -it, and have a license header in the style used by the project. - -### SPDX-License-Identifier -A full list of license identifiers can be found on [the SPDX website](https://spdx.org/licenses/). - -## Style -Please use the [One True Brace style](https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS_.28OTBS.29). -Tabs are 4 spaces. - -For ease of use, you can set the following astyle configuration: -``` ---style=otbs ---attach-namespaces ---attach-inlines ---indent=spaces=4 -``` - -## Format patch for email -```sh -git format-patch hash -``` -where _hash_ is the commit immediately prior to the commit or series of commits -you want to submit. - -Attach the patch file and email it to _aqua at iserlohn-fortress.net_. If -possible, GPG sign the email. diff --git a/docs/manual/Features.1.0.md b/docs/manual/Features.1.0.md deleted file mode 100644 index 59348d3..0000000 --- a/docs/manual/Features.1.0.md +++ /dev/null @@ -1,32 +0,0 @@ -# Version 1.0 -* Profiles - - Application-level profile manager - - System-level and user-level profile config, with per-profile overrides [todo] -* Configuration - - Default system-level config and user-level overrides [todo] -* Cookies - - Filter list similar to the URL filter list [todo] -* Tabs - - Moving tabs between windows [todo] - - Tab context menu [todo] -* Page actions - - Search [todo] - - Zoom [todo] - - Print [todo] -* Navigation toolbar - - Back and Forward history [todo] - -## Components -Components should, when possible, be split off into self-contained static -libraries. This is to reduce recompile times. - -### Navigation -Includes the Address bar (URLLineEdit). - -### Bookmarks - -- [TODO] Bookmark location should be read from profile, with a default in the config -- [TODO] Split off xbel implementation into a library -- [TODO] BookmarksLibrary API - -### Downloads diff --git a/docs/manual/Quickstart.md b/docs/manual/Quickstart.md deleted file mode 100644 index b8dcaa1..0000000 --- a/docs/manual/Quickstart.md +++ /dev/null @@ -1,15 +0,0 @@ -# Quickstart - -## Installing and running - -### Linux - -### Windows -Grab a package from (not yet available url). - -## Configuration files -On first run, smolbote will create its basic configuration: -- on Linux, in _~/.config/smolbote_ -- on Windows, in - -## Troubleshooting diff --git a/linux/makepkg/PKGBUILD.generic b/linux/makepkg/PKGBUILD.generic index 9a17f9b..98f132f 100644 --- a/linux/makepkg/PKGBUILD.generic +++ b/linux/makepkg/PKGBUILD.generic @@ -38,7 +38,7 @@ build() { #cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DUseLibCpp=On "$srcdir/smolbote-git" # build, with 4 threads - make -j 4 + make } package() { |