diff --git a/readme-ko.md b/readme-ko.md new file mode 100644 index 00000000..ffbdc35e --- /dev/null +++ b/readme-ko.md @@ -0,0 +1,47 @@ +# Boostnote + +오픈소스 노트 앱 + +## Goal + +그냥 글쓰는게 즐거워지셨으면 좋겠어요. :grinning: + +- 타겟 OS : OSX, Windows, Linux(나중엔 모바일까지도!) +- Cloud : Google drive, Dropbox, One drive, iCloud... +- 오픈소스로 남을 것! + +## 영감받은 앱/서비스 + +- Atom +- Quiver +- Evernote +- GitKraken +- GitBook + +## Using stack + +- Electron +- React +- Webpack +- Redux +- CSSModules + +## Codestyle + +[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) + +## Author + +[Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r) + +## Contributors + +- [dojineko](https://github.com/dojineko) +- [Romain Bazile](https://github.com/gromain) +- [Bruno Paz](https://github.com/brpaz) + +## Copyright & License + +Copyright (C) 2016 MAISIN&CO. + +[GPL v3](./LICENSE). diff --git a/readme.md b/readme.md index 597af87a..d46d4fec 100644 --- a/readme.md +++ b/readme.md @@ -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).