extern/heynote
1
0
Fork 0
mirror of https://github.com/heyman/heynote.git synced 2024-11-22 07:54:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Minor README changes

Browse Source
This commit is contained in:
Jonatan Heyman 2023-07-08 16:59:01 +02:00
parent fe2c006817
commit 069e23e90d
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -3,7 +3,9 @@
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/heyman/heynote)](https://github.com/heyman/heynote/releases) [![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). 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 ## 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 > 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. 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.