heynote/README.md

55 lines
1.8 KiB
Markdown

# Heynote
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/heyman/heynote)](https://github.com/heyman/heynote/releases)
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 and Windows. Linux support coming soon (hopefully).
## 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
- Default or Emacs-like key bindings
## Installation
Download the appropriate (ARM Mac, Intel Mac, or Windows) version from the latest Github release. The Windows build is not signed, so you might have to approve some warning (I could not justify paying a yearly fee for a certificate just to get rid of that).
## Development
To develop Heynote, 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.
Heynote is built upon [CodeMirror](https://codemirror.net/), [Math.js](https://mathjs.org/), [Prettier](https://prettier.io/) and other great open-source projects.