Skip to content

README.md

Latest commit

 

History

History
68 lines (45 loc) · 2.68 KB

README.md

File metadata and controls

68 lines (45 loc) · 2.68 KB
Raw

VNote

CI-Windows CI-Linux CI-MacOS

简体中文

Project on Gitee

A pleasant note-taking platform.

For more information, please visit VNote's Home Page.

VNote

Description

VNote is a Qt-based, free and open source note-taking application. It combines note management with an excellent editing experience across multiple document formats.

VNote runs on Linux, Windows, and macOS.

Supported formats

VNote is more than a Markdown editor — these formats are supported today:

  • Markdown (.md, .mkd, .rmd, .markdown): write, edit, and preview Markdown notes
  • Plain text and source code (.txt, .log, .py, .cpp, .js, .json, .yaml, and more): edit text notes, logs, code, and configuration files
  • Mind maps (.mmm, .emind): create and edit mind maps with the native mind-map editor
  • PDF (.pdf): read PDF documents with the built-in viewer

The built-in PDF viewer requires a Qt 6.9+ build. Older builds, including the Windows 7 / Qt 5.15 package, open PDFs in the system default application.

Main

Downloads

Continuous builds on master branch could be found at the Continuous Build release.

Latest stable builds could be found at the latest release or Gitee release

Supports

Thank users who donated to VNote!

Development

After cloning the repository, run the initialization script to set up your development environment:

Linux/macOS:

bash scripts/init.sh

Windows:

scripts\init.cmd

This script will:

  • Initialize and update all git submodules
  • Install pre-commit hooks for automatic code formatting with clang-format
  • Set up the vtextedit submodule pre-commit hook

For more development guidelines, see AGENTS.md.

License

VNote is licensed under GNU LGPLv3.

Bundled third-party material and the notices its licenses require — the Lucide (ISC/MIT) and IconPark (Apache-2.0) icon sets — are recorded in THIRD-PARTY-NOTICES.md.