Merge branch 'laurent22:dev' into fix-9588

readme/dev/BUILD.md

@@ -43,7 +43,7 @@ Then you can test the various applications:
 	cd packages/app-desktop
 	yarn start
 
-You can also run it under WSL 2. To do so, [follow these instructions](https://www.beekeeperstudio.io/blog/building-electron-windows-ubuntu-wsl2) to setup your environment.
+Use the regular Command Prompt to develop in Windows. We [do not recommend using WSL for this](https://github.com/laurent22/joplin/blob/dev/readme/dev/build_troubleshooting.md#other-issues) and we do not support this use case.
 
 ## Testing the Terminal application
 

readme/dev/build_troubleshooting.md

@@ -1,8 +1,6 @@
 # Build troubleshooting
 
-## Desktop application
-
-### On Windows
+## Desktop application - on Windows
 
 If `yarn dist` fails, it may need administrative rights.
 
@@ -15,7 +13,7 @@ call "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\VC\Auxiliar
 set "PATH=C:\Program Files\nodejs;%PATH%"
 ```
 
-### On Linux and macOS
+## Desktop application - on Linux and macOS
 
 If there's an error `while loading shared libraries: libgconf-2.so.4: cannot open shared object file: No such file or directory`, run `sudo apt-get install libgconf-2-4`
 
@@ -24,18 +22,20 @@ If you get a node-gyp related error, you might need to manually install it: `npm
 If you get unexpected `npm` dependency errors on a fresh git pull, try `npm run clean`
 
 If `npm i` gives you a fatal error like the following:
+
 ```
 node-pre-gyp WARN Tried to download(403): https://mapbox-node-binary.s3.amazonaws.com/sqlite3/v5.0.1/napi-v6-linux-x64.tar.gz 
 node-pre-gyp WARN Pre-built binaries not found for sqlite3@5.0.1 and node@14.15.4 (node-v83 ABI, glibc) (falling back to source compile with node-gyp)
 /bin/sh: 1: python: not found
 ```
+
 Try `sudo apt install python` (or the `apt` equivalent for your operating system) and then run `npm i` again.
 
 If you get the error `libtool: unrecognized option '-static'`, follow the instructions [in this post](https://stackoverflow.com/a/38552393/561309) to use the correct libtool version.
 
-### Other issues
+## Desktop application - other issues
 
-> The application window doesn't open or is white
+### The application window doesn't open or is white
 
 This is an indication that there's an early initialisation error. Try this:
 
@@ -44,19 +44,13 @@ This is an indication that there's an early initialisation error. Try this:
 - Also try to delete node_modules and rebuild.
 - If all else fails, switch your computer off and on again, to make sure you start clean.
 
-> How to work on the app from Windows?
+### How to work on the app from Windows?
 
 **You should not use WSL at all** because this is a GUI app that lives outside of WSL, and the WSL layer can cause all kind of very hard to debug issues. It can also lock files in node_modules that cannot be unlocked when the app crashes. (You need to restart your computer.) Likewise, don't run the TypeScript watch command from WSL.
 
 So everything should be done from a Windows Command prompt or Windows PowerShell running as Administrator. All build and start commands are designed to work cross-platform, including on Windows.
 
-> Error when building the application
-
-If you find a error when building the application, [verify that you have all the requirements](https://github.com/laurent22/joplin/blob/dev/readme/dev/BUILD.md), including Rust. 
-
-## Mobile application
-
-### iOS
+## Mobile application - iOS
 
 If there is an error `/joplin/packages/app-mobile/ios/Pods/Target Support Files/Pods-Joplin/Pods-Joplin.debug.xcconfig: unable to open file (in target "Joplin" in project "Joplin") (in target 'Joplin' from project 'Joplin')` run the following commands: