From 76355b791ca70b756edd44526a77144c16fe43f1 Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Thu, 9 Feb 2017 18:19:25 +0100 Subject: Updated readme and contributing --- CONTRIBUTING.md | 5 ++++- README.md | 8 ++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7641c13..c9e9d7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ Please include the following when reporting bugs: ### Hooks Symlink the hooks: ``` -ln -s ../../util/pre-commit.sh .git/hooks/pre-commit +[smolbote repo]$ ln -s ../../util/pre-commit.sh .git/hooks/pre-commit ``` ### Versioning @@ -42,6 +42,9 @@ Major bugfixes and each new feature should get a revision. /src/webengine | QWebEngine* subclasses /test | test run location, mainly for QtCreator +### Licensing +Please include an appropriate license header in any file you add. + ### QtCreator * In the project Run Settings set the working directory to _$repo/test_, and the command line arguments to _-c ./config.ini_. diff --git a/README.md b/README.md index 59bbae0..f0005d5 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ ## *smolbote* -_yet another Qute browser_ +_yet another Qt 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 +* configurable - in easy to find and edit text files ### 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.][1] +You make it yourself after taking a cursory glance at [BUILDING.md][1]. -1: https://gitlab.com/xiannox/smolbote/blob/master/BUILDING.md +[1]: https://gitlab.com/xiannox/smolbote/blob/master/BUILDING.md -- cgit v1.2.1