Getting Started with Notolog¶

This guide will help you install Notolog and get up and running quickly.

Table of Contents¶

• Installation Methods
• First Launch
• Creating Your First Note
• Basic Navigation
• Next Steps

Installation Methods¶

Method 1: pip (Recommended)¶

The simplest way to install Notolog is via pip:

# Create a virtual environment (recommended)
python3 -m venv notolog_env

# Activate the environment
source notolog_env/bin/activate  # Linux/macOS
notolog_env\Scripts\activate     # Windows

# Install Notolog
pip install notolog

# Or with llama.cpp support for GGUF models
pip install "notolog[llama]"

# Upgrade to latest version
pip install --upgrade notolog

# Uninstall
pip uninstall notolog

Method 2: Conda¶

# Create and activate environment
conda create -n notolog_env python=3.11
conda activate notolog_env

# Install from conda-forge
conda install notolog -c conda-forge

Method 3: Debian Package¶

For Ubuntu/Debian users:

# Check the latest version at:
# https://github.com/notolog/notolog-debian/releases

# Download the latest release (replace X.Y.Z with the actual version, e.g., 1.1.6)
wget https://github.com/notolog/notolog-debian/releases/download/vX.Y.Z/notolog_X.Y.Z_amd64.deb
# Or
wget https://github.com/notolog/notolog-debian/releases/latest/download/notolog_X.Y.Z_amd64.deb

# Install
sudo dpkg -i notolog_X.Y.Z_amd64.deb

Tip: Visit the releases page to find the latest version number.

Method 4: From Source¶

git clone https://github.com/notolog/notolog-editor.git
cd notolog-editor
python3 -m venv notolog_env
source notolog_env/bin/activate
pip install .

First Launch¶

After installation, start Notolog:

notolog

Or from source:

python -m notolog.app

On first launch, you'll see the main editor window with:

1. File Tree (left panel) - Navigate your notes
2. Editor Area (center) - Write and edit Markdown
3. Toolbar (top) - Quick access to common actions
4. Status Bar (bottom) - File information and navigation

Creating Your First Note¶

1. Set a Notes Directory:
2. Go to Settings → General → Default folder for notes

3. Choose or create a directory for your notes

4. Create a New File:

5. Right-click in the file tree → New File

6. Or use the toolbar button

7. Start Writing:

   # My First Note
   
   This is a **Markdown** note created with Notolog!
   
   ## Features I Like
   - Syntax highlighting
   - Auto-save
   - Clean interface
   

8. Switch to View Mode:

9. Click the View/Edit toggle in the toolbar
10. See your Markdown rendered as HTML

Basic Navigation¶

Keyboard Shortcuts¶

Shortcuts marked as "Planned" are not yet implemented.

File Tree Actions¶

• Single-click: Open file
• Right-click: Context menu (rename, delete, new file/folder)

Editor Features¶

• Line Numbers: Click to jump to a line
• Search: Ctrl+F to find text in the current file
• Quick Filter: Type in the file tree search box to filter files

Next Steps¶

Now that you're set up, explore these features:

1. User Guide - Learn all the features
2. AI Assistant - Chat with AI models locally or via API
3. Configuration - Customize themes and settings
4. File Encryption - Secure sensitive notes

Troubleshooting First Launch¶

Qt Platform Plugin Error (Linux)¶

If you see: qt.qpa.plugin: Could not load the Qt platform plugin "xcb"

sudo apt-get install -y libxcb-cursor0

Permission Errors¶

Ensure you have write access to the notes directory:

chmod 755 ~/Documents/Notes

Python Version Issues¶

Verify your Python version:

python3 --version  # Should be 3.10+

Need more help? Check the FAQ or start a discussion.