mirror of
https://github.com/BoostIo/Boostnote
synced 2025-12-13 01:36:22 +00:00
add readme and update keywords in package.json
This commit is contained in:
@@ -16,15 +16,12 @@
|
||||
"url": "git+https://github.com/Rokt33r/codexen-app.git"
|
||||
},
|
||||
"keywords": [
|
||||
"boost",
|
||||
"boostnote",
|
||||
"b00st",
|
||||
"boostio",
|
||||
"note",
|
||||
"snippet",
|
||||
"template",
|
||||
"task",
|
||||
"runner",
|
||||
"code",
|
||||
"storage",
|
||||
"short code"
|
||||
],
|
||||
"author": "Dick Choi <fluke8259@gmail.com> (http://kazup.co)",
|
||||
"bugs": {
|
||||
|
||||
93
readme.md
Normal file
93
readme.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# Boostnote
|
||||
|
||||
Hack your memory
|
||||
|
||||
## Develope
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
## Using stack
|
||||
|
||||
- Electron
|
||||
- React
|
||||
- Webpack
|
||||
... check [`package.json`](./package.json)
|
||||
|
||||
## Codestyle
|
||||
|
||||
[](https://github.com/feross/standard)
|
||||
|
||||
## Author
|
||||
|
||||
[Rokt33r(Dick Choi)](https://github.com/rokt33r)
|
||||
|
||||
## License
|
||||
|
||||
[Check here](./LICENSE).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user