heynote/README.md
Noah Andrews a871291ec6
Remove reference to Linux support "coming soon" in the README (#18)
* Note that Linux support is now available in the README
2023-12-22 18:43:36 +01:00

2.0 KiB

Heynote

GitHub release (latest SemVer)

Heynote is a dedicated scratchpad for developers. It functions as a large persistent text buffer where you can write down anything you like. Works great for that Slack message you don't want to accidentally send, a JSON response from an API you're working with, notes from a meeting, your daily to-do list, etc.

The Heynote buffer is divided into blocks, and each block can have its own Language set (e.g. JavaScript, JSON, Markdown, etc.). This gives you syntax highlighting and lets you auto-format that JSON response.

Available for Mac, Windows, and Linux.

Features

  • Persistent text buffer
  • Block-based
  • Syntax highlighting
    • C++
    • CSS
    • HTML
    • Java
    • JavaScript
    • JSON
    • Markdown
    • PHP
    • Python
    • Rust
    • SQL
    • XML
  • Language auto-detection
  • Auto-formatting
  • Math/Calculator mode
  • Currency conversion
  • Multi-cursor editing
  • Dark & Light themes
  • Option to set a global hotkey to show/hide the app
  • Default or Emacs-like key bindings

Installation

Download the appropriate (Mac, Windows or Linux) version from the latest Github release (or from heynote.com). The Windows build is not signed, so you might see some scary warning (I can not justify paying a yearly fee for a certificate just to get rid of that).

Development

To develop Heynote you need Node.js and you should (hopefully) just need to check out the code and then run:

> npm install
> npm run dev

Contributions

I'm happy to merge contributions that fit my vision for the app. Bug fixes are always welcome.

Thanks!

Heynote is built upon CodeMirror, Vue, Electron, Math.js, Prettier and other great open-source projects.