Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix some typos and reword some bits in README and CONTRIBUTING

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2021-01-23 13:14:50 +01:00
parent 6f84574511
commit 3f8c705989
2 changed files with 39 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+19 -23
View File
@@ -1,10 +1,9 @@
# Contributing Guide # Contributing Guide
When contributing to this repository, please first discuss the change you wish to make via the When contributing to this repository, please first discuss the change you wish to make via the
issue tracker with the owner of this repository before making a change. If you just want to make a issue tracker or the discussions page with the owner of this repository before making a change. If
minor correction, like fix a typo or similar, feel free to just make a pull request directly. you just want to make a minor correction, like fix a typo or similar, feel free to just make a pull
request directly.
There is a code of conduct. Please follow it in all your interactions with the project.
## Pull Request Process ## Pull Request Process
@@ -13,11 +12,13 @@ There is a code of conduct. Please follow it in all your interactions with the p
2. Please provide a complete description of the changes in the pull request, and a summary that can 2. Please provide a complete description of the changes in the pull request, and a summary that can
be copied into the [CHANGELOG](CHANGELOG.md). Remember to reference any issue related by be copied into the [CHANGELOG](CHANGELOG.md). Remember to reference any issue related by
providing the issue number. providing the issue number.
3. Do not change the version number unless asked to do so. Version numbers are bumped in separate 3. Do not change the version number. Version numbers are bumped in separate release pull requests
release pull requests by the maintainer. by the maintainer.
## Code of Conduct ## Code of Conduct
There is a code of conduct. Please follow it in all your interactions with the project.
### Our Pledge ### Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers In the interest of fostering an open and welcoming environment, we as contributors and maintainers
@@ -31,7 +32,7 @@ Please see the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file for the full text.
## Code Style Guide ## Code Style Guide
The source code of novelWriter broadly follows the [PEP8](https://www.python.org/dev/peps/pep-0008) The source code of novelWriter broadly follows the [PEP8](https://www.python.org/dev/peps/pep-0008)
style guide , but with a few modifications and exceptions. style guide, but with a few modifications and exceptions listed below.
### Line Length ### Line Length
@@ -39,20 +40,21 @@ For this project, source lines should stay within the 79 and 99 character limits
79 characters is often too restrictive, so 99 character lines are acceptable when that is more 79 characters is often too restrictive, so 99 character lines are acceptable when that is more
practical. Readability has priority. Generally, if a code statement requires multiple lines, the practical. Readability has priority. Generally, if a code statement requires multiple lines, the
lines should wrap at 79 characters, not 99. If wrapping can be avoided by going to 99, then that is lines should wrap at 79 characters, not 99. If wrapping can be avoided by going to 99, then that is
preferrable. generally preferrable.
For text files, the text should also be wrapped at 99 character. The exception is markdown image For text files, the text should also be wrapped at 99 character. The exception is markdown image
tags and urls. tags and urls.
Please do not submit PRs that re-wrap existing source or text unless this has been discussed Please do not submit pull requests that re-wrap existing source or text unless this has been
beforehand. discussed beforehand.
### Linting with flake8 ### Linting with `flake8`
An excellent tool for checking Python code for errors and coding style is `flake8`. The An excellent tool for checking Python code for errors and coding style is `flake8`. The
documentation is available [here](https://flake8.pycqa.org/en/latest/). documentation is available [here](https://flake8.pycqa.org/en/latest/).
The `setup.cfg` file in the root of this project has the following settings: The `setup.cfg` file in the root of this project has the following settings for `flake8` that
matches the coding standard:
```conf ```conf
[flake8] [flake8]
ignore = E203,E221,E226,E228,E241,E251,E261,E266,E302,E305 ignore = E203,E221,E226,E228,E241,E251,E261,E266,E302,E305
@@ -73,23 +75,17 @@ not conform to the standard.
## Ignored Errors ## Ignored Errors
Some `flake8` error codes are ignored for this project for various reasons. The source also uses Some `flake8` error codes are ignored for this project for various reasons. The source also uses
camelCase function and variable names due to this being the standard for the Qt libraries, and also camelCase function and variable names. This is the standard for the Qt libraries novelWriter
because of the author's personal preferences. integrates with. It also happens to be the author's personal preferences.
The reason behind the other ignored error codes are listed below. Many of them are due to PEP8 not The reason behind the other ignored error codes are listed below. Many of them are due to PEP8 not
permitting column alignment as opposed to many other coding styles. I find them useful in regions permitting column alignment as opposed to many other coding styles, like for instance for Go. I
of bulk value assignments. There's a reason why tables are more readable than lists. They should be find them useful in regions of bulk value assignments. There's a reason why tables are more
used sparingly though. readable than lists. They should be used sparingly though.
The ignored errors are all `pycodestyle` errors, and they are documented The ignored errors are all `pycodestyle` errors, and they are documented
[here](https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes). [here](https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes).
My main objection to PEP8 is the universal rejection of column alignment of blocks of code. In
particular when assigning variables and populating dictionaries. The PEP8 rule stands in contrast
to conventions from other code styles, like for Go. I have always used column alignment to a
certain degree in all programming languages I use, and I firmly believe it improves readability,
but should not be overused.
**E203:** whitespace before ‘:’ **E203:** whitespace before ‘:’
**Reason:** Column alignment. **Reason:** Column alignment.
README.md
+20 -19
View File
@@ -26,25 +26,25 @@ synchronisation tools. The core project structure is stored in a single project
meta data is primarily saved in JSON files. meta data is primarily saved in JSON files.
The full documentation is available at The full documentation is available at
[novelwriter.readthedocs.io](https://novelwriter.readthedocs.io/). [novelwriter.readthedocs.io](https://novelwriter.readthedocs.io).
## Implementation ## Implementation
The application is written in Python 3 using Qt5 via PyQt5. It is developed on Linux, but it should The application is written in Python 3 using Qt5 via PyQt5. It is developed on Linux, but it should
in principle work fine on other operating systems as well as long as dependencies are met. The unit in principle work fine on other operating systems as well, as long as dependencies are met. The
tests are run on the latest versions of Ubuntu Linux, Windows Server and macOS. unit tests are run on the latest versions of Ubuntu Linux, Windows Server and macOS.
## Project Contributions ## Project Contributions
Contributions to this project are welcome. However, please read the Contributing Guide before Contributions to this project are welcome. However, please read the
submitting larger additions ot changes to this project. You can find the guide here: [Contributing Guide](https://github.com/vkbo/novelWriter/blob/main/CONTRIBUTING.md) before
[CONTRIBUTING.md](https://github.com/vkbo/novelWriter/blob/main/CONTRIBUTING.md). submitting larger additions ot changes to this project.
# Key Features # Key Features
Some features of novelWriter are listed below. Consult the Some features of novelWriter are listed below. Consult the
[documentation](https://novelwriter.readthedocs.io/) for more information. [documentation](https://novelwriter.readthedocs.io) for more information.
### Markdown Flavour ### Markdown Flavour
@@ -52,7 +52,7 @@ novelWriter is _not_ a full-feature Markdown editor. It is a plain text editor t
Markdown-like syntax for adding a minimal set of formatting that is useful for the specific task Markdown-like syntax for adding a minimal set of formatting that is useful for the specific task
of writing novels. The formatting is currently limited to: of writing novels. The formatting is currently limited to:
* Headings level 1 to 4 using the `#` syntax only. * Headings levels 1 to 4 using the `#` syntax only.
* Emphasised and strongly emphasised text. These are rendered as italicised and bold text. * Emphasised and strongly emphasised text. These are rendered as italicised and bold text.
* Strikethrough text. * Strikethrough text.
* Hard line breaks using two or more spaces at the end of a line. * Hard line breaks using two or more spaces at the end of a line.
@@ -68,7 +68,7 @@ In addition, novelWriter adds the following, which is otherwise not supported by
* A set of meta data keyword/values starting with the character `@`. This is used for tagging * A set of meta data keyword/values starting with the character `@`. This is used for tagging
and inter-linking documents, and can also be included when generate a project outline. and inter-linking documents, and can also be included when generate a project outline.
* A variety of thin and non-breaking spaces are supported. Some of them depend on the system * A variety of thin and non-breaking spaces are supported. Some of them depend on the system
running at least Qt 5.9. running at least Qt 5.9. Earlier versions of Qt will unfortunately strip them out when saving.
* Tabs can be used in the text, and should be properly aligned in both editor and viewer. This can * Tabs can be used in the text, and should be properly aligned in both editor and viewer. This can
be used to make simple tables and lists. Full Markdown tables and lists are not supported. Note be used to make simple tables and lists. Full Markdown tables and lists are not supported. Note
that for HTML exports, most browsers will treat a tab as a space, so it may not show up like that for HTML exports, most browsers will treat a tab as a space, so it may not show up like
@@ -76,8 +76,8 @@ In addition, novelWriter adds the following, which is otherwise not supported by
expected. expected.
The core export format of novelWriter is HTML5. You can also export the entire project as a single The core export format of novelWriter is HTML5. You can also export the entire project as a single
novelWriter Markdown-flavour document. These can be imported again into novelWriter. In addition, novelWriter Markdown-flavour document. These can later be imported again into novelWriter. In
other exports to Open Document, PDF, and plain text is offered through the Qt library, although addition, export to Open Document, PDF, and plain text is offered through the Qt library, although
with limitations to formatting. with limitations to formatting.
The HTML format is well suited for file conversion tools and import into other text editors. The HTML format is well suited for file conversion tools and import into other text editors.
@@ -91,11 +91,11 @@ syntax highlighting themes. Optional GUI themes are also available, including da
### Easy Organising of Project Files ### Easy Organising of Project Files
The structure of the project is shown on the left hand side of the main GUI. Project files are The structure of the project is shown on the left hand side of the main window. Project files are
organised into root folders, indicating what class of file they are. The most important root folder organised into root folders, indicating what class of file they are. The most important root folder
is the `Novel` folder, which contains all of the files that make up the finished novel. Each root is the `Novel` folder, which contains all of the files that make up the finished novel. Each root
folder can have subfolders. Folders have no impact on the final project structure, they are there folder can have subfolders. Subfolders have no impact on the final project structure, they are
for you to organise your files in whatever way you need. there for you to organise your files in whatever way you want.
The editor supports four levels of headings, which determines what level the following text belongs The editor supports four levels of headings, which determines what level the following text belongs
to. Headings of level one signify a book or partition title. Headings of level two signify the to. Headings of level one signify a book or partition title. Headings of level two signify the
@@ -104,10 +104,11 @@ four can be used internally in each scene to separate sections.
Each novel file can be assigned a layout format, which shows up as a flag next to the item in the Each novel file can be assigned a layout format, which shows up as a flag next to the item in the
project tree. These are mostly to help the user track what they contain, but they also have some project tree. These are mostly to help the user track what they contain, but they also have some
impact on the format of the exported document. See the documentation for further details. impact on the format of the exported document. See the
[documentation](https://novelwriter.readthedocs.io) for further details.
#### Project Notes ### Project Notes
Supporting note files can be added for the story plot, characters, locations, story timeline, etc. Supporting note files can be added for the story plot, characters, locations, story timeline, etc.
These have their separate root folders. These are optional files. These have their separate root folders. These are optional files.
@@ -149,7 +150,6 @@ Dependencies should be installed automatically, but can also be installed direct
```bash ```bash
pip install pyqt5 lxml pyenchant pip install pyqt5 lxml pyenchant
``` ```
When installing via pip, novelWriter can be launched from command line with: When installing via pip, novelWriter can be launched from command line with:
```bash ```bash
novelWriter novelWriter
@@ -169,7 +169,8 @@ python setup.py xdg-install
``` ```
This should make novelWriter available as a regular application on your system, with a launceher This should make novelWriter available as a regular application on your system, with a launceher
icon and file association with novelWriter project files. icon, and file association with novelWriter project files.
### Setup on macOS ### Setup on macOS
@@ -178,7 +179,7 @@ If you're installing from source, the following commands will set up novelWriter
brew install enchant brew install enchant
pip3 install --user -r requirements.txt pip3 install --user -r requirements.txt
pip3 install --user pyobjc pip3 install --user pyobjc
python setup.py install python3 setup.py install
``` ```
At present, novelWriter isn't further integrated into the OS, so you must launch it from command At present, novelWriter isn't further integrated into the OS, so you must launch it from command