diff --git a/README.md b/README.md index 775babe0..19588559 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,15 @@ [![codecov](https://codecov.io/gh/vkbo/novelWriter/branch/master/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter) [![Documentation Status](https://readthedocs.org/projects/novelwriter/badge/?version=latest)](https://novelwriter.readthedocs.io/en/latest/?badge=latest) + novelWriter is a markdown-like text editor designed for writing novels and larger projects of many smaller plain text documents. +novelWriter uses its own flavour of markdown that supports mete data syntax for comments, synopsis and cross-referencing between files. -The documentation is available here: [novelwriter.readthedocs.io](https://novelwriter.readthedocs.io/). +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](LICENSE.md) file. +The bundled Typicon-based icon themes are licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/). + +Below is a short overview of the features of novelWriter. +The full documentation is available at [novelwriter.readthedocs.io](https://novelwriter.readthedocs.io/). ### Note @@ -174,4 +180,4 @@ They broadly follow Python PEP8, but there are a few modifications. ![Screenshot 1](docs/source/images/screenshot_default.png) **novelWriter with dark theme:** -![Screenshot 1](docs/source/images/screenshot_dark.png) +![Screenshot 2](docs/source/images/screenshot_dark.png) diff --git a/assets/icons/1024x1024/novelwriter.png b/assets/icons/1024x1024/novelwriter.png new file mode 100644 index 00000000..537d7895 Binary files /dev/null and b/assets/icons/1024x1024/novelwriter.png differ diff --git a/assets/icons/1024x1024/x-novelwriter-project.png b/assets/icons/1024x1024/x-novelwriter-project.png new file mode 100644 index 00000000..d0eba36d Binary files /dev/null and b/assets/icons/1024x1024/x-novelwriter-project.png differ diff --git a/assets/icons/128x128/novelwriter.png b/assets/icons/128x128/novelwriter.png new file mode 100644 index 00000000..83562a6e Binary files /dev/null and b/assets/icons/128x128/novelwriter.png differ diff --git a/assets/icons/128x128/x-novelwriter-project.png b/assets/icons/128x128/x-novelwriter-project.png new file mode 100644 index 00000000..60ebc23f Binary files /dev/null and b/assets/icons/128x128/x-novelwriter-project.png differ diff --git a/assets/icons/16x16/novelwriter.png b/assets/icons/16x16/novelwriter.png new file mode 100644 index 00000000..5723b8c5 Binary files /dev/null and b/assets/icons/16x16/novelwriter.png differ diff --git a/assets/icons/16x16/x-novelwriter-project.png b/assets/icons/16x16/x-novelwriter-project.png new file mode 100644 index 00000000..b34c29c4 Binary files /dev/null and b/assets/icons/16x16/x-novelwriter-project.png differ diff --git a/assets/icons/16x16@2x/novelwriter.png b/assets/icons/16x16@2x/novelwriter.png new file mode 100644 index 00000000..6e62b8e8 Binary files /dev/null and b/assets/icons/16x16@2x/novelwriter.png differ diff --git a/assets/icons/16x16@2x/x-novelwriter-project.png b/assets/icons/16x16@2x/x-novelwriter-project.png new file mode 100644 index 00000000..bb439d8d Binary files /dev/null and b/assets/icons/16x16@2x/x-novelwriter-project.png differ diff --git a/assets/icons/18x18@2x/novelwriter.png b/assets/icons/18x18@2x/novelwriter.png new file mode 100644 index 00000000..fd16d0bf Binary files /dev/null and b/assets/icons/18x18@2x/novelwriter.png differ diff --git a/assets/icons/18x18@2x/x-novelwriter-project.png b/assets/icons/18x18@2x/x-novelwriter-project.png new file mode 100644 index 00000000..a8307a12 Binary files /dev/null and b/assets/icons/18x18@2x/x-novelwriter-project.png differ diff --git a/assets/icons/24x24/novelwriter.png b/assets/icons/24x24/novelwriter.png new file mode 100644 index 00000000..5a41986f Binary files /dev/null and b/assets/icons/24x24/novelwriter.png differ diff --git a/assets/icons/24x24/x-novelwriter-project.png b/assets/icons/24x24/x-novelwriter-project.png new file mode 100644 index 00000000..14e47ad3 Binary files /dev/null and b/assets/icons/24x24/x-novelwriter-project.png differ diff --git a/assets/icons/256x256/novelwriter.png b/assets/icons/256x256/novelwriter.png new file mode 100644 index 00000000..b59a2cc0 Binary files /dev/null and b/assets/icons/256x256/novelwriter.png differ diff --git a/assets/icons/256x256/x-novelwriter-project.png b/assets/icons/256x256/x-novelwriter-project.png new file mode 100644 index 00000000..20930c8c Binary files /dev/null and b/assets/icons/256x256/x-novelwriter-project.png differ diff --git a/assets/icons/32x32/novelwriter.png b/assets/icons/32x32/novelwriter.png new file mode 100644 index 00000000..6e62b8e8 Binary files /dev/null and b/assets/icons/32x32/novelwriter.png differ diff --git a/assets/icons/32x32/x-novelwriter-project.png b/assets/icons/32x32/x-novelwriter-project.png new file mode 100644 index 00000000..bb439d8d Binary files /dev/null and b/assets/icons/32x32/x-novelwriter-project.png differ diff --git a/assets/icons/32x32@2x/novelwriter.png b/assets/icons/32x32@2x/novelwriter.png new file mode 100644 index 00000000..a9b48904 Binary files /dev/null and b/assets/icons/32x32@2x/novelwriter.png differ diff --git a/assets/icons/32x32@2x/x-novelwriter-project.png b/assets/icons/32x32@2x/x-novelwriter-project.png new file mode 100644 index 00000000..0f2d49d2 Binary files /dev/null and b/assets/icons/32x32@2x/x-novelwriter-project.png differ diff --git a/assets/icons/48x48/novelwriter.png b/assets/icons/48x48/novelwriter.png new file mode 100644 index 00000000..dcfca2fd Binary files /dev/null and b/assets/icons/48x48/novelwriter.png differ diff --git a/assets/icons/48x48/x-novelwriter-project.png b/assets/icons/48x48/x-novelwriter-project.png new file mode 100644 index 00000000..ffbd21d7 Binary files /dev/null and b/assets/icons/48x48/x-novelwriter-project.png differ diff --git a/assets/icons/512x512/novelwriter.png b/assets/icons/512x512/novelwriter.png new file mode 100644 index 00000000..a1ac535b Binary files /dev/null and b/assets/icons/512x512/novelwriter.png differ diff --git a/assets/icons/512x512/x-novelwriter-project.png b/assets/icons/512x512/x-novelwriter-project.png new file mode 100644 index 00000000..5348f53d Binary files /dev/null and b/assets/icons/512x512/x-novelwriter-project.png differ diff --git a/assets/icons/64x64/novelwriter.png b/assets/icons/64x64/novelwriter.png new file mode 100644 index 00000000..a9b48904 Binary files /dev/null and b/assets/icons/64x64/novelwriter.png differ diff --git a/assets/icons/64x64/x-novelwriter-project.png b/assets/icons/64x64/x-novelwriter-project.png new file mode 100644 index 00000000..0f2d49d2 Binary files /dev/null and b/assets/icons/64x64/x-novelwriter-project.png differ diff --git a/assets/icons/96x96/novelwriter.png b/assets/icons/96x96/novelwriter.png new file mode 100644 index 00000000..5255334f Binary files /dev/null and b/assets/icons/96x96/novelwriter.png differ diff --git a/assets/icons/96x96/x-novelwriter-project.png b/assets/icons/96x96/x-novelwriter-project.png new file mode 100644 index 00000000..a950104c Binary files /dev/null and b/assets/icons/96x96/x-novelwriter-project.png differ diff --git a/assets/icons/novelwriter.ico b/assets/icons/novelwriter.ico new file mode 100644 index 00000000..470ebe72 Binary files /dev/null and b/assets/icons/novelwriter.ico differ diff --git a/assets/icons/novelwriter.svg b/assets/icons/novelwriter.svg new file mode 100644 index 00000000..e8df3435 --- /dev/null +++ b/assets/icons/novelwriter.svg @@ -0,0 +1,117 @@ + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/assets/icons/x-novelwriter-project.svg b/assets/icons/x-novelwriter-project.svg new file mode 100644 index 00000000..1d9e9d5d --- /dev/null +++ b/assets/icons/x-novelwriter-project.svg @@ -0,0 +1,147 @@ + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + diff --git a/assets/installDebian.sh b/assets/installDebian.sh new file mode 100755 index 00000000..19fab36a --- /dev/null +++ b/assets/installDebian.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +cd .. + +EXEC=$(pwd)/novelWriter.py +EXEC=$(echo $EXEC | sed 's_/_\\/_g') + +sed "s/%%exec%%/$EXEC/g" assets/novelwriter.desktop > /usr/share/applications/novelwriter.desktop + +cp -v assets/icons/24x24/novelwriter.png /usr/share/icons/hicolor/24x24/apps/ +cp -v assets/icons/48x48/novelwriter.png /usr/share/icons/hicolor/48x48/apps/ +cp -v assets/icons/96x96/novelwriter.png /usr/share/icons/hicolor/96x96/apps/ +cp -v assets/icons/256x256/novelwriter.png /usr/share/icons/hicolor/256x256/apps/ +cp -v assets/icons/512x512/novelwriter.png /usr/share/icons/hicolor/512x512/apps/ +cp -v assets/icons/1024x1024/novelwriter.png /usr/share/icons/hicolor/1024x1024/apps/ +cp -v assets/icons/novelwriter.svg /usr/share/icons/hicolor/scalable/apps/ +cp -v assets/icons/x-novelwriter-project.svg /usr/share/icons/hicolor/scalable/mimetypes/application-x-novelwriter-project.svg +cp -v assets/mime/x-novelwriter-project.xml /usr/share/mime/packages/ + +update-mime-database /usr/share/mime/ +update-icon-caches /usr/share/icons/hicolor/ diff --git a/assets/mime/x-novelwriter-project.xml b/assets/mime/x-novelwriter-project.xml new file mode 100644 index 00000000..21ecbe0a --- /dev/null +++ b/assets/mime/x-novelwriter-project.xml @@ -0,0 +1,8 @@ + + + + novelWriter Project + + + + diff --git a/assets/novelwriter.desktop b/assets/novelwriter.desktop new file mode 100644 index 00000000..2e6901d3 --- /dev/null +++ b/assets/novelwriter.desktop @@ -0,0 +1,10 @@ +[Desktop Entry] +Type=Application +Encoding=UTF-8 +Name=novelWriter +Comment=Multi-document markdown editor for novels +Exec=%%exec%% %f +Icon=novelwriter +Categories=GTK;GNOME;Office; +Terminal=false +MimeType=application/x-novelwriter-project diff --git a/nw/assets/icons/novelWriter.ico b/nw/assets/icons/novelWriter.ico index 0a27ee4f..470ebe72 100644 Binary files a/nw/assets/icons/novelWriter.ico and b/nw/assets/icons/novelWriter.ico differ diff --git a/nw/assets/icons/novelWriter.png b/nw/assets/icons/novelWriter.png deleted file mode 100644 index 4543f575..00000000 Binary files a/nw/assets/icons/novelWriter.png and /dev/null differ diff --git a/nw/assets/icons/novelWriter.svg b/nw/assets/icons/novelWriter.svg index 56a3dff0..e8df3435 100644 --- a/nw/assets/icons/novelWriter.svg +++ b/nw/assets/icons/novelWriter.svg @@ -1,68 +1,82 @@ - - + version="1.1" + viewBox="0 0 270.93333 270.93334" + height="1024" + width="1024" + inkscape:export-filename="/home/vkbo/Code/novelWriter/Icons/novelWriter/Version 3/icons/18x18@2x/novelwriter.png" + inkscape:export-xdpi="3.375" + inkscape:export-ydpi="3.375"> - - - - - + + + + + + + inkscape:window-y="0" + inkscape:window-x="0" + inkscape:window-height="1344" + inkscape:window-width="2560" + inkscape:pagecheckerboard="true" + units="px" + showgrid="false" + inkscape:document-rotation="0" + inkscape:current-layer="layer1" + inkscape:document-units="px" + inkscape:cy="665.4051" + inkscape:cx="469.95914" + inkscape:zoom="0.49497475" + inkscape:pageshadow="2" + inkscape:pageopacity="0" + borderopacity="1.0" + bordercolor="#666666" + pagecolor="#ffffff" + id="base" /> @@ -76,36 +90,28 @@ + inkscape:groupmode="layer" + inkscape:label="Background"> + inkscape:label="Box" + ry="21.166666" + rx="21.166666" + y="5.8208332" + x="5.8208332" + height="259.29166" + width="259.29166" + id="rect1467" + style="display:inline;fill:#b6afaf;fill-opacity:0.69999999;stroke:#857a7a;stroke-width:2.64583;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.69803923" /> + + - - - - + inkscape:label="n" + d="m 82.55,52.916667 c -11.726333,0 -21.166666,9.440333 -21.166666,21.166666 v 52.916147 a 74.08333,74.08333 0 0 0 0,5.3e-4 74.08333,74.08333 0 0 0 0,0.005 v 52.912 c 0,11.72633 9.440333,21.16666 21.166666,21.16666 11.726333,0 21.16667,-9.44033 21.16667,-21.16666 v -52.91667 a 31.75,31.75 0 0 1 31.74999,-31.749997 31.75,31.75 0 0 1 31.75,31.749997 v 74.87708 h -22.6441 c -1.45336,0 -2.62361,0.59079 -2.62361,1.32447 0,0.13836 0.0421,0.27171 0.11937,0.39687 h -0.11782 c 0.0818,0.53871 0.32835,1.05778 0.74517,1.47433 l 43.8149,43.78699 c 1.03733,1.03666 2.70767,1.03667 3.74499,0 l 43.81541,-43.78699 c 0.4169,-0.41662 0.66338,-0.93551 0.74518,-1.47433 h -0.11782 c 0.0773,-0.12516 0.11937,-0.25851 0.11937,-0.39687 0,-0.73368 -1.17027,-1.32447 -2.62362,-1.32447 h -22.64409 v -74.87708 a 74.08333,74.08333 0 0 0 -74.08333,-74.083333 74.08333,74.08333 0 0 0 -0.21446,0 74.08333,74.08333 0 0 0 -35.312564,9.074382 C 96.123154,56.500593 89.772151,52.916667 82.55,52.916667 Z" + style="fill:#740c0c;fill-opacity:1;stroke:#631d1d;stroke-width:2.64583;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + id="rect1406" />