-
Notifications
You must be signed in to change notification settings - Fork 139
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MindForger 2.0.0 release via pull request #1532 from dvorka/dev/2.0.0
- Loading branch information
Showing
578 changed files
with
49,356 additions
and
10,417 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,6 @@ | ||
| [submodule "doc"] | ||
| path = doc | ||
| url = https://github.com/dvorka/mindforger-repository.git | ||
| [submodule "deps/mitie"] | ||
| path = deps/mitie | ||
| url = https://github.com/dvorka/MITIE.git | ||
| [submodule "deps/cmark-gfm"] | ||
| path = deps/cmark-gfm | ||
| url = https://github.com/dvorka/cmark.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Contribute to MindForger | ||
|
|
||
| MindForger is free and open source software. Feel free to **contribute** - any help | ||
| MindForger is free and open source software. Feel free to **contribute** - any help | ||
| with MindForger development will be **highly appreciated**! | ||
|
|
||
| * **Bugs and Suggestions** | ||
|
|
@@ -13,33 +13,50 @@ with MindForger development will be **highly appreciated**! | |
| * Submit pull request/patch with implementation of a feature you missed. | ||
| * **Integration** | ||
| * How-to or code enabling integration with your (favorite) project. | ||
| * **Enhancements** | ||
| * **Enhancements** | ||
| * Submit performance, efficiency and/or productivity enhancements suggestions (code, bug or docs) | ||
| * **Documentation** | ||
| * **Documentation** | ||
| * Write a document, block post; create YouTube video, ... | ||
|
|
||
| Don't hesitate to contact [me](mailto:[email protected]). | ||
|
|
||
| **Table of contents**: | ||
|
|
||
| * [Code of Conduct](#code-of-conduct) | ||
| * [Styleguide: Git Commit Messages](#styleguide--git-commit-messages) | ||
| * [Styleguide: C++](#styleguide--c) | ||
| * [Styleguide: C++ Comments](#styleguide--c---comments) | ||
| * [Styleguide: Qt](#styleguide--qt) | ||
|
|
||
|
|
||
| # Code of Conduct | ||
| This project and everyone participating in it is governed by the | ||
| This project and everyone participating in it is governed by the | ||
| [MindForger Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this | ||
| code. | ||
|
|
||
|
|
||
| # Styleguide: Git Commit Messages | ||
| * Commit messages must provide concise change description. | ||
| * Reference issues and pull requests related to the commit. | ||
| * Close bugs with issue references in commit messages. | ||
| * If possible, limit commit message length to 72 characters. | ||
|
|
||
|
|
||
| # Styleguide: C++ | ||
| Code style: | ||
|
|
||
| * Use `.h` extension for header files. | ||
| * Use `.cpp` extension for class files. | ||
| * Use `lower_case_with_unserscores` source code file names. | ||
| * Use `lower_case_with_underscores` source code file names. | ||
| * Spaces, no tabs. | ||
| * No trailing whitespaces. | ||
| * Use `{}` with constructor having 0/1 parameter, () otherwise. | ||
| * `CamelCase` class names (no underscores). | ||
| * Lines to have at most 88 columns. | ||
| * See `/lib/src` source code for as code style reference. | ||
| - Guide in Qt Creator: `Tools` > `Options` > `Text editor` > `Display` > `Display right margin at column` = 88 | ||
| * 4 spaces indentation. | ||
| * Python's black like formatting. | ||
| * Use `/lib/src` source code as code style reference. | ||
|
|
||
| Example of class `{}` style: | ||
|
|
||
|
|
@@ -54,8 +71,8 @@ public: | |
| ... | ||
|
|
||
| void myFunction(int myParam) { ... } | ||
| int myMultiLineFunction() const { | ||
|
|
||
| int myMultiLineFunction() const { | ||
| ... | ||
| } | ||
|
|
||
|
|
@@ -78,7 +95,7 @@ bool MyClass::myFunction(const QString& myArg) | |
| } | ||
| ``` | ||
|
|
||
| Example of how to format code to keep it under 88 columns: | ||
| Example of how to format code to keep it under 88 columns (Python's black style): | ||
|
|
||
| ```cpp | ||
| void MainWindowPresenter::doActionOrganizerMoveNoteToNextVisibleQuadrant(Note* note) | ||
|
|
@@ -87,8 +104,7 @@ void MainWindowPresenter::doActionOrganizerMoveNoteToNextVisibleQuadrant(Note* n | |
| doActionKanbanMoveNoteCommon( | ||
| note, | ||
| orloj->getKanban()->moveToNextVisibleColumn(note), | ||
| orloj | ||
| ); | ||
| orloj); | ||
| } else { | ||
| if(!EisenhowerMatrix::isEisenhowMatrixOrganizer( | ||
| orloj->getOrganizer()->getOrganizer() | ||
|
|
@@ -99,19 +115,88 @@ void MainWindowPresenter::doActionOrganizerMoveNoteToNextVisibleQuadrant(Note* n | |
| doActionOrganizerMoveNoteCommon( | ||
| note, | ||
| orloj->getOrganizer()->moveToNextVisibleQuadrant(note), | ||
| orloj | ||
| ); | ||
| orloj); | ||
| } else { | ||
| statusBar->showError( | ||
| "Notebooks/notes cannot be moved around quadrants of " | ||
| "Eisenhower Matrix" | ||
| ); | ||
| "Eisenhower Matrix"); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| # Styleguide: C++ Comments | ||
| Comments should be used to explain tricky and/or | ||
| important code only. Don't use comments to explain | ||
| obvious things as comments might diverge from the | ||
| actual code (e.g. after code refactoring) and may | ||
| cause confusion. Make comments brief, consistent | ||
| and concise | ||
| Code style: | ||
| ```cpp | ||
| /** | ||
| * @brief Brief class description. | ||
| * | ||
| * Detailed class description which may include | ||
| * `examples` of use, _ASCII diagrams_ or **bullet lists**. | ||
| * Do ~~not~~ worry. | ||
| * | ||
| * Code block: | ||
| * | ||
| * int codeBlockExampleVariable; | ||
| * | ||
| * @see Text (as sentence) or URL. | ||
| * @see [The link text](http://example.com/) | ||
| * @see [The link text](#MyOtherClass) | ||
| */ | ||
| class MyClass | ||
| { | ||
| int field; // brief field description in the lower case | ||
| /** | ||
| * @brief Another field. | ||
| * | ||
| * Field with a long description must be documented using | ||
| * this style of the comment. The text of description to be | ||
| * formed by sentences. Apart to that you can use any formatting | ||
| * syntax from below. | ||
| */ | ||
| int anotherField; | ||
| public: | ||
| ... | ||
| /** | ||
| * @brief Brief method description. | ||
| * | ||
| * Detailed method description which may include | ||
| * examples of use, ASCII diagrams or bullet/numbered | ||
| * lists like: | ||
| * | ||
| * 1. The first item. | ||
| * 2. The second item with the reference of `field`. | ||
| * 3. The third item. | ||
| * | ||
| * @param myParam Parameter documentation as sentence(s). | ||
| * @return Return value description as sentence(s). | ||
| * | ||
| * @see [The link text](#MyOtherClass) | ||
| */ | ||
| void myMethod(int myParam) { ... } | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| # Styleguide: Qt | ||
|
|
||
| * MindForger uses MVP pattern (see `main_window_presenter.h/.cpp`) | ||
| * See `/src/qt` source code for a code style reference. | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,47 @@ | ||
| 2024-02-16 Martin Dvorak <[email protected]> | ||
|
|
||
| * Released v2.0.0 - a major release that removes unused features | ||
| and brings several new features like Wingman. | ||
| * Feature: Wingman brings OpenAI LLM integration allowing to | ||
| compose, rewrite, summarize, NER or fix grammar of notes. | ||
| * Feature: Notebook Tree view brings ability to organize Notebooks to | ||
| a tree (outline). | ||
| * Feature: Libraries bring ability to index external PDF files and generate | ||
| Notebooks which represent them in MindForger. Synchronization and removal | ||
| of the library (directory with files) is supported as well. | ||
| * Feature: Emojis dialog allowing to use Unicode-based emojis | ||
| in Notebooks and Notes names or text. | ||
| * Feature: CLI can newly search knowledge on the internet sites - like | ||
| Wikipedia, arXiv, or StackOverflow - on phrase which is the current | ||
| context (Notebook or Note name; selected text or text under the cursor) | ||
| in order to get more information about the phrase. | ||
| * Enhancement: CLI rewrite - help, search, knowledge search | ||
| (Wikipedia, arXiv, search engines) and commands. | ||
| * Enhancement: Limbo added to the application menu View/Limbo. | ||
| * Enhancement: Polished Preferences - Appearance refactored to Controls, | ||
| restart requirement highlighted. | ||
| * Enhancement: Added up and down button in O/N preview mode to move around | ||
| O's Ns while presenting a N. | ||
| * Enhancement: MindForger icon changed to GenAI style. | ||
| * Enhancement: menu refactoring impacting Scope, and Navigate and various | ||
| menu items. | ||
| * Fix: Missing OOTB Eisenhower Matrix is automatically added back to | ||
| the list of Organizers. | ||
| * Fix: Conflicting menu keyboard shortcuts resolution (e.g. Organizers view). | ||
| * Fix: Edit and Format menus re-enabled on single Markdown file configuration. | ||
| * Upgrade: new version(s) of Qt with enhanced security support | ||
| added - Qt 5.15.2 LTS is supported on macOS and Windows. | ||
| * Deprecation: dashboard view removed. | ||
| * Deprecation: experimental Mitie (NER) code removed (replaced by LLM integration). | ||
|
|
||
| 2023-01-15 Martin Dvorak <[email protected]> | ||
|
|
||
| * Released v1.55.0 - a minor release which fixes delete of a Note in | ||
| the Notebook view that now keeps selected an adjacent Note, improves | ||
| page up/page down navigation in table widgets, adds charset to | ||
| the exported HTML head, adds new Note templates, and renames Repository | ||
| to Workspace in the UI (source code kept intact). | ||
|
|
||
| 2022-03-07 Martin Dvorak <[email protected]> | ||
|
|
||
| * Released v1.54.0 - macOS fix release: Qt downgraded from 5.9.9 (security) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.