1
0
mirror of https://github.com/BoostIo/Boostnote synced 2025-12-13 09:46:22 +00:00

update readme

This commit is contained in:
Dick Choi
2016-05-29 05:22:37 +09:00
parent dbfd25bb8e
commit eb210e9072
2 changed files with 57 additions and 50 deletions

View File

@@ -1,6 +1,14 @@
# Boostnote
Simple note app
Simple opensource note app for developer.
## Goal
We just want you to enjoying writing anything. :grinning:
- Target OS : OSX, Windows, Linux(also mobile somewhen!)
- Cloud : Google drive, Dropbox, One drive, iCloud...
- Remaining opensource forever!
## Inspired by
@@ -10,51 +18,6 @@ Simple note app
- GitKraken
- GitBook
## System requirement
This app is built on Electron.
You can check it from [here](https://github.com/electron/electron/blob/master/docs/tutorial/supported-platforms.md).
Currently, I'm testing this app on Windows 10(64bit), OS X El Capitan, Ubuntu Linux, Arch Linux.
## Develop
1. turn on HMR server
```
npm run webpack
```
2. run hot mode
```
npm run hot
```
> `npm start` is using compiled scripts. see [Build](#Build) to compile scripts.
## Build
1. Compile scripts
compile all browser stuff(Javascript, Stylus).
```
grunt compile
```
2. Build executable
build `Boostnote.app` (OS X) / `Boostnote.exe` (Windows)
```
grunt pack:osx
grunt pack:windows
```
Also there are some tasks for CodeSign(OS X) and Authenticode(Windows). To use these tasks, you need to aquire your own certifications.
## Using stack
- Electron
@@ -63,7 +26,6 @@ Also there are some tasks for CodeSign(OS X) and Authenticode(Windows). To use t
- Redux
- CSSModules
## Codestyle
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
@@ -82,6 +44,4 @@ Also there are some tasks for CodeSign(OS X) and Authenticode(Windows). To use t
Copyright (C) 2016 MAISIN&CO.
[Check here](./LICENSE).
[GPL v3](./LICENSE).