-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add readme and electron start script
- Loading branch information
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Chronicles | ||
|
||
**Status**: In development. Bugs abound. See releases to download the application. | ||
|
||
|
||
|
||
## Development | ||
|
||
All of the application code lives in the `/ui` directory. Ignore the others :) | ||
|
||
|
||
|
||
The app is a typical Electron dev setup, but serves the UI from webpack dev server while in development. To start the app you'll need to start both the webpack dev server and electron. | ||
|
||
```bash | ||
cd ui | ||
|
||
# install dependencies | ||
yarn | ||
|
||
# start webpack | ||
yarn dev | ||
|
||
# start electron | ||
# yarn dev:electron | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
## Build and release | ||
|
||
- Use the `ui/build.sh` script | ||
- Make a Github release | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters