From e99e3eb6c40b2184eedf3fbaa422b7cba8c850cd Mon Sep 17 00:00:00 2001 From: Rokt33r Date: Sat, 14 May 2016 12:29:53 +0900 Subject: [PATCH] update readme --- readme.md | 101 +++++++++++++----------------------------------------- 1 file changed, 24 insertions(+), 77 deletions(-) diff --git a/readme.md b/readme.md index a66d8f9c..597af87a 100644 --- a/readme.md +++ b/readme.md @@ -2,13 +2,13 @@ Simple note app -## Progress Kanban +## Inspired by -https://trello.com/b/wJlinZJx/boostnote-todo-list - -This is a public Kanban board. Also everyone can comment here. - -If you want to join us, ask me to add you. +- Atom +- Quiver +- Evernote +- GitKraken +- GitBook ## System requirement @@ -18,103 +18,50 @@ You can check it from [here](https://github.com/electron/electron/blob/master/do Currently, I'm testing this app on Windows 10(64bit), OS X El Capitan, Ubuntu Linux, Arch Linux. -## About note storage - -Currently, Boostnote stores data to a single json file. - -You can find it from the path below. - -OS X -``` -/Users/$USER_NAME$/Library/Application Support/boost/local.json -``` - -Windows -``` -C:\Users\$USER_NAME$\AppData\Roaming\boost\local.json -``` - -On v0.6.0, You will be able to select any folder in your file system. - ## Develop 1. turn on HMR server -``` -npm run webpack -``` + ``` + npm run webpack + ``` 2. run hot mode -``` -npm run hot -``` + ``` + npm run hot + ``` > `npm start` is using compiled scripts. see [Build](#Build) to compile scripts. - ## Build -> '3. Codesign' and '4. Create' installer are needed to deploy this app. -> You can skip these steps. - 1. Compile scripts -compile all browser stuff(Javascript, Stylus). + compile all browser stuff(Javascript, Stylus). -``` -grunt compile -``` + ``` + grunt compile + ``` 2. Build executable -build `Boostnote.app` (OS X) / `Boostnote.exe` (Windows) + build `Boostnote.app` (OS X) / `Boostnote.exe` (Windows) -``` -grunt pack:osx -grunt pack:windows -``` + ``` + grunt pack:osx + grunt pack:windows + ``` -3. Codesign (OSX only) - -codesign with Certification. - -``` -grunt codesign -``` - -> `OSX_COMMON_NAME` must be defined inside `/secret/auth_code.json`. - -> codesigning on windows is included to creating installer. - -4. Create installer - -create installer, `Boostnote.dmg`(OSX) / `Setup.exe`(Windows). - -``` -grunt create-windows-installer -``` - -> #### Windows only -> `WIN_CERT_PASSWORD` must be defined inside `/secret/auth_code.json`. -> `/secret/authenticode_cer.p12` is required also. - -5. Zip (OSX only) - -zip `Boostnote.app` file. - -``` -grunt zip:osx -``` - -> Stuff(Setup.exe, .nupkg) of Windows are not needed to be zipped. +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 - React - Webpack -... check [`package.json`](./package.json) +- Redux +- CSSModules ## Codestyle