Browse Source

Document that the main process is not restarted

Manav Rathi 1 year ago
parent
commit
31ad9a3eb3
2 changed files with 8 additions and 6 deletions
  1. 1 1
      desktop/README.md
  2. 7 5
      desktop/docs/dev.md

+ 1 - 1
desktop/README.md

@@ -28,7 +28,7 @@ Install dependencies
 yarn install
 yarn install
 ```
 ```
 
 
-Run in development mode (with hot reload)
+Run in development mode (supports hot reload for the renderer process)
 
 
 ```sh
 ```sh
 yarn dev
 yarn dev

+ 7 - 5
desktop/docs/dev.md

@@ -4,14 +4,16 @@
 
 
 ### yarn dev
 ### yarn dev
 
 
-Launch the app in development mode
+Launch the app in development mode:
 
 
--   Runs a development server for the renderer, with HMR.
+-   Transpiles the files in `src/` and starts the main process.
 
 
--   Starts tsc in watch mode to recompile the JS files used by the main process.
+-   Runs a development server for the renderer (with hot module reload).
 
 
--   Starts the main process, reloading it on changes to the the TS files in
-    `src/`.
+-   Starts tsc in watch mode to recompile the JS files used by the main process.
+    Note that the main process is not restarted on changes automatically, you'll
+    still need to restart the app manually – running tsc in watch mode is still
+    useful to notice any errors.
 
 
 ### yarn build
 ### yarn build