Skip to content

README.md

Latest commit

 

History

History
165 lines (114 loc) · 4.43 KB

README.md

File metadata and controls

165 lines (114 loc) · 4.43 KB
Raw

NeuronNotes

A minimal, beautiful note-taking app with bidirectional linking. Your local-first second brain.

Version Platform Python License

Download

Download NeuronNotes.exe (Latest Release)

No installation required. No Python needed. Double click and go.

Features

  • Clean, distraction-free markdown editor
  • Bidirectional wiki-links with [[note name]] syntax
  • Ctrl+Click any link to jump between notes instantly
  • Auto-creates linked notes on demand
  • Backlinks panel showing which notes link to the current note
  • Tag system with #hashtag syntax, highlighted in coral pink
  • Sidebar tag browser with note counts, click to filter
  • Instant search across all notes with empty-state feedback
  • Auto-save while you type
  • Coral-pink accent theme, easy on the eyes
  • Notes stored as plain .md files, your data stays yours
  • Standalone .exe, no installation, no accounts, no cloud

How It Works

Linking notes: Type [[MyNote]] anywhere in your notes to create a link. Hold Ctrl and click the link to jump to that note. If the note doesn't exist yet, NeuronNotes offers to create it for you.

Tagging notes: Add #hashtags anywhere in your notes. They'll be highlighted automatically and grouped in the sidebar tag panel. Click any tag to filter notes containing it.

Backlinks: The right panel shows every note that links back to the one you're currently viewing. Follow ideas in both directions.

This is your second brain: interconnected thoughts, effortless navigation.

Keyboard Shortcuts

Key Action
Ctrl + N New Note
Ctrl + S Save Note (auto-saves anyway)
Ctrl + Click Follow wiki-link
Right Click Delete note (in sidebar)

Run From Source

Requires Python 3.10 or later.

git clone https://github.com/The-Python-Dev/neuronnotes.git
cd neuronnotes
pip install -r requirements.txt
python run.py

Build Your Own EXE

Install development dependencies (includes runtime + build tools):

pip install -r requirements-dev.txt
python build.py

Output: dist/NeuronNotes.exe

Project Structure

neuronnotes/
├── run.py                    # Entry point
├── build.py                  # PyInstaller build script
├── make_icon.py              # Icon generator utility
├── app/
│   ├── core/                 # Business logic (no UI)
│   │   ├── note_manager.py
│   │   ├── link_engine.py
│   │   └── constants.py
│   ├── ui/                   # All visual components
│   │   ├── main_window.py
│   │   ├── sidebar.py
│   │   ├── editor.py
│   │   └── theme.py
│   ├── utils/                # Helper modules
│   │   ├── config.py
│   │   └── file_handler.py
│   └── assets/               # Icons and resources
│       ├── icon.ico
│       └── icon.png
├── requirements.txt
├── requirements-dev.txt
├── CHANGELOG.md
├── README.md
└── LICENSE

See CHANGELOG.md for release history.

Your Data

  • All notes stored as plain .md (Markdown) files
  • You pick your vault folder, notes stay on YOUR computer
  • No cloud, no account, no tracking, no subscription
  • Compatible with Obsidian, Typora, VS Code, or any text editor
  • Deleted notes go to .trash/ folder inside your vault (recoverable)

Known Issues (v1.1.0)

  • Icon may appear small/pixelated at 16x16 sizes (Windows rendering quirk)
  • No graph view yet (planned for v1.2)
  • No light theme yet (planned for v1.2)

Roadmap

v1.2

  • Interactive graph view of connected notes
  • Light theme + additional theme options
  • Daily notes button
  • Export to PDF
  • Smaller EXE bundle size (migrating build environment off Anaconda)

v2.0

  • Plugin system
  • Cross-platform (Mac, Linux)

Built With

  • Python 3
  • PyQt6
  • PyInstaller

License

MIT License

Author

Made by Om Dautkhani

Built with love in a caffeine-free zone. Just water and vibes.