Skip to content

Commit 5b35378

Browse files
committed
changes to readme with clearer instructions
1 parent 54dd6c4 commit 5b35378

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
This is an example electron/create-react-app application, and serves as an example of how to structure your project if you want to share pieces of your codebase between electron and react.
44

5-
## Project structure
5+
## Usage
66

7-
- `electron/`: Code for the main Electron process
8-
- `src/react/`: Code for the React renderer process
9-
- `src/shared/`: Code shared between React and Electron
10-
- `package.json`: Contains scripts for running the app in development, building it, and packaging it for production using electron-builder
7+
- Clone this repository
8+
- cd into the directory and run `npm install`
119

1210
## Development
1311

@@ -20,6 +18,13 @@ This is an example electron/create-react-app application, and serves as an examp
2018
- A new `dist` folder will be created in the root of your project containing the executable files
2119
NOTE: add `--mac` to the `postpackage` script besides `--win` if you are on a mac computer
2220

21+
## Project structure
22+
23+
- `electron/`: Code for the main Electron process
24+
- `src/react/`: Code for the React renderer process
25+
- `src/shared/`: Code shared between React and Electron
26+
- `package.json`: Contains scripts for running the app in development, building it, and packaging it for production using electron-builder
27+
2328
## Contributing
2429

2530
Open a new PR to contribute

0 commit comments

Comments
 (0)