The todo.txt application Todour

You can always download the latest release on nerdur.com. Or just build your own.

The program uses QtAwesome for the icons.

https://sverrirvalgeirsson.github.io/Todour/

git clone https://github.com/SverrirValgeirsson/Todour.git
cd Todour
git submodule init 
git submodule update 

qmake Todour.pro
make

The project uses MkDocs to generate static documentation from Markdown files. The documentation source is located in the documentation/ directory and is automatically deployed to GitHub Pages.

documentation/
├── mkdocs.yml          # MkDocs configuration file
└── docs/
    ├── index.md        # Homepage/Introduction
    ├── generic usage.md # General usage guide
    ├── commands.md     # Command reference
    ├── settings.md     # Settings documentation
    └── License.md      # License information

Install MkDocs using pip:

pip install mkdocs

For additional themes and plugins (optional):

pip install mkdocs-material
pip install mkdocs-awesome-pages-plugin

cd documentation

# Start local development server
mkdocs serve

# The documentation will be available at: http://127.0.0.1:8000
# Changes to Markdown files will auto-reload in the browser

1. Create a new .md file in the docs/ directory
2. Add the page to the navigation in mkdocs.yml:

   nav:
       - 'index.md'
       - 'new-page.md'  # Add your new page here
       - 'settings.md'

3. Preview your changes with mkdocs serve

Deploy the documentation to the live site:

cd documentation
mkdocs gh-deploy

This command will:

• Build the documentation into static HTML
• Push the generated files to the gh-pages branch
• Update the live documentation automatically

If you need to build without deploying:

cd documentation
mkdocs build
# Generated files will be in the site/ directory

The documentation is automatically published to: https://sverrirvalgeirsson.github.io/Todour/

• Permission errors: Ensure you have write access to the repository
• Build failures: Check that all Markdown files have valid syntax
• Missing dependencies: Install MkDocs with pip install mkdocs
• Navigation issues: Verify that all pages listed in mkdocs.yml exist in the docs/ directory

On Ubuntu 20.04 the following has been reported to be needed (see #28)

sudo apt install qtchooser
sudo apt install qt5-default
sudo apt install qtbase5-private-dev
sudo apt install cmake
sudo apt install libxcb-keysyms1-dev
sudo apt install clang

Please note that there is a small part of the code that checks on nerdur.com if there is an update available. This should not be an issue, but if you are making your own copy you may want to disable this. This is done in aboutbox.cpp, and can be turned off by simply commenting out the line in the constructor that says "requestPage.."