mirror of
https://github.com/heyman/heynote.git
synced 2024-11-21 23:43:22 +01:00
Minor README changes
This commit is contained in:
parent
fe2c006817
commit
069e23e90d
@ -3,7 +3,9 @@
|
||||
[![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.
|
||||
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).
|
||||
|
||||
@ -39,7 +41,7 @@ Download the appropriate (ARM Mac, Intel Mac, or Windows) version from the lates
|
||||
|
||||
## Development
|
||||
|
||||
To develop Heynote, you should (hopefully) just need to check out the code and then run:
|
||||
To develop Heynote you need Node.js and you should (hopefully) just need to check out the code and then run:
|
||||
|
||||
```
|
||||
> npm install
|
||||
@ -50,5 +52,5 @@ To develop Heynote, you should (hopefully) just need to check out the code and t
|
||||
|
||||
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.
|
||||
Heynote is built upon [CodeMirror](https://codemirror.net/), [Vue](https://vuejs.org/), [Electron](https://www.electronjs.org/) [Math.js](https://mathjs.org/), [Prettier](https://prettier.io/) and other great open-source projects.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user