From 732450e16354e5130c2fe2c71fead1df3f0a95ed Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 25 Jul 2021 16:50:12 +0200 Subject: [PATCH] Add CREDITS file and update README (#833) * Add CREDITS file and update README * Fix typo and add note in Libraries section of CREDITS --- CREDITS.md | 42 ++++++++++++++++++++++++++++++++++++++++++ README.md | 25 +++++-------------------- 2 files changed, 47 insertions(+), 20 deletions(-) create mode 100644 CREDITS.md diff --git a/CREDITS.md b/CREDITS.md new file mode 100644 index 00000000..dc6b4c53 --- /dev/null +++ b/CREDITS.md @@ -0,0 +1,42 @@ +# Credits + +## Main Developer + +* Veronica Berglyd Olsen (@vkbo) + +## Main Contributors + +* Concept: Marian Lückhof (@Number042) +* Internationalisation: Bruno Meneguello (@bkmeneguello) + +## Translations + +* French: Jan Lüdke (@jyhelle) +* Norwegian: Veronica Berglyd Olsen (@vkbo) +* Portuguese: Bruno Meneguello (@bkmeneguello) +* Simplified Chinese: Qianzhi Long (@longqzh) + +## Libraries + +The following libraries are dependencies of novelWriter: + +* Qt5 by [Qt Company](https://www.qt.io/) +* PyQt5 by [Riverbank Computing](https://www.riverbankcomputing.com/software/pyqt/) +* lxml by [Martijn Faassen](https://lxml.de/) +* Enchant by [Dom Lachowicz](https://abiword.github.io/enchant/) +* PyEnchant by [Dimitri Merejkowsky](https://pyenchant.github.io/pyenchant/) + +## Assets + +Some of the assets bundled with novelWriter were adapted from the following sources: + +* Typicons icons by Stephen Hutchings (CC BY-SA 4.0) +* Cantarell font by Dave Crossland (OPEN FONT LICENSE Version 1.1) +* Tomorrow syntax themes by Chris Kempson (MIT License) +* Owl syntax themes by Sarah Drasner (MIT License) +* Solarized themes by Ethan Schoonover, added by @nullbasis (MIT License) + +## Special Mentions + +Additional thanks to @johnblommers who was an early user and who has provided a lot of very useful +feedback over the years. diff --git a/README.md b/README.md index 55f07b73..6d589bf0 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ JSON files. The full documentation is available on [readthedocs.io](https://novelwriter.readthedocs.io). +The full credits are listed in [CREDITS.md](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md). + ## Implementation The application is written in Python 3 (3.6+) using Qt5 and PyQt5 (5.3+). It is developed on Linux, @@ -190,7 +192,7 @@ PATH" during the installation. The script `windows_install.bat` in the `setup` folder can be used to create desktop and start menu icons for novelWriter. The script will also install dependencies for you from PyPi. -## Internationalisation +### Internationalisation If you install from source, you must build the translation files yourself if you want to switch to a different GUI language than British English. This requires that you have the Qt translation @@ -209,25 +211,8 @@ This is Open Source software, and novelWriter is licensed under GPLv3. See the [GNU General Public License website](https://www.gnu.org/licenses/gpl-3.0.en.html) for more details, or consult the [LICENSE](https://github.com/vkbo/novelWriter/blob/main/LICENSE.md) file. -Bundled assets have the following licenses: - -* The Typicons-based icon themes by Stephen Hutchings are licensed under - [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/). The icons have been altered in - size and colour for use with novelWriter, and some additional icons added. The original icon set - is available at - [stephenhutchings/typicons.font](https://github.com/stephenhutchings/typicons.font). -* The Cantarell font by Dave Crossland is licensed under - [OPEN FONT LICENSE Version 1.1](http://scripts.sil.org/OFL). - It is available at [Google Fonts](https://fonts.google.com/specimen/Cantarell). -* The Tomorrow syntax themes use colour schemes taken from Chris Kempson's collection of code - editor themes, licensed with the - [MIT License](https://github.com/chriskempson/tomorrow-theme/blob/master/LICENSE.md), - and the main repo is available at - [chriskempson/tomorrow-theme](https://github.com/chriskempson/tomorrow-theme). -* Likewise, the Owl syntax themes use colours from Sarah Drasner's code editor themes, licensed - with the [MIT License](https://github.com/sdras/night-owl-vscode-theme/blob/master/LICENSE), and - the main repo is available at - [sdras/night-owl-vscode-theme](https://github.com/sdras/night-owl-vscode-theme). +Bundled assets and their licenses are listed in +[CREDITS](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md). ## Screenshots