Skip to content

Commit e99e3eb

Browse files
committed
update readme
1 parent 508615b commit e99e3eb

1 file changed

Lines changed: 24 additions & 77 deletions

File tree

readme.md

Lines changed: 24 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Simple note app
44

5-
## Progress Kanban
5+
## Inspired by
66

7-
https://trello.com/b/wJlinZJx/boostnote-todo-list
8-
9-
This is a public Kanban board. Also everyone can comment here.
10-
11-
If you want to join us, ask me to add you.
7+
- Atom
8+
- Quiver
9+
- Evernote
10+
- GitKraken
11+
- GitBook
1212

1313
## System requirement
1414

@@ -18,103 +18,50 @@ You can check it from [here](https://github.com/electron/electron/blob/master/do
1818

1919
Currently, I'm testing this app on Windows 10(64bit), OS X El Capitan, Ubuntu Linux, Arch Linux.
2020

21-
## About note storage
22-
23-
Currently, Boostnote stores data to a single json file.
24-
25-
You can find it from the path below.
26-
27-
OS X
28-
```
29-
/Users/$USER_NAME$/Library/Application Support/boost/local.json
30-
```
31-
32-
Windows
33-
```
34-
C:\Users\$USER_NAME$\AppData\Roaming\boost\local.json
35-
```
36-
37-
On v0.6.0, You will be able to select any folder in your file system.
38-
3921
## Develop
4022

4123
1. turn on HMR server
4224

43-
```
44-
npm run webpack
45-
```
25+
```
26+
npm run webpack
27+
```
4628

4729
2. run hot mode
4830

49-
```
50-
npm run hot
51-
```
31+
```
32+
npm run hot
33+
```
5234

5335
> `npm start` is using compiled scripts. see [Build](#Build) to compile scripts.
5436
55-
5637
## Build
5738

58-
> '3. Codesign' and '4. Create' installer are needed to deploy this app.
59-
> You can skip these steps.
60-
6139
1. Compile scripts
6240

63-
compile all browser stuff(Javascript, Stylus).
41+
compile all browser stuff(Javascript, Stylus).
6442

65-
```
66-
grunt compile
67-
```
43+
```
44+
grunt compile
45+
```
6846

6947
2. Build executable
7048

71-
build `Boostnote.app` (OS X) / `Boostnote.exe` (Windows)
72-
73-
```
74-
grunt pack:osx
75-
grunt pack:windows
76-
```
77-
78-
3. Codesign (OSX only)
79-
80-
codesign with Certification.
81-
82-
```
83-
grunt codesign
84-
```
85-
86-
> `OSX_COMMON_NAME` must be defined inside `/secret/auth_code.json`.
87-
88-
> codesigning on windows is included to creating installer.
89-
90-
4. Create installer
91-
92-
create installer, `Boostnote.dmg`(OSX) / `Setup.exe`(Windows).
93-
94-
```
95-
grunt create-windows-installer
96-
```
97-
98-
> #### Windows only
99-
> `WIN_CERT_PASSWORD` must be defined inside `/secret/auth_code.json`.
100-
> `/secret/authenticode_cer.p12` is required also.
101-
102-
5. Zip (OSX only)
103-
104-
zip `Boostnote.app` file.
49+
build `Boostnote.app` (OS X) / `Boostnote.exe` (Windows)
10550

106-
```
107-
grunt zip:osx
108-
```
51+
```
52+
grunt pack:osx
53+
grunt pack:windows
54+
```
10955

110-
> Stuff(Setup.exe, .nupkg) of Windows are not needed to be zipped.
56+
Also there are some tasks for CodeSign(OS X) and Authenticode(Windows). To use these tasks, you need to aquire your own certifications.
11157

11258
## Using stack
11359

11460
- Electron
11561
- React
11662
- Webpack
117-
... check [`package.json`](./package.json)
63+
- Redux
64+
- CSSModules
11865

11966

12067
## Codestyle

0 commit comments

Comments
 (0)