self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-24 08:12:24 +02:00
Code Issues Releases Activity

Documentation: Edit build instructions to avoid confusion (#2376)

Browse Source 
* Edits build instructions to avoid confusion

When i was trying to build the Electron Project, i was a bit confused about which commands to follow for building in the projects on my OS (Windows).
there was two header  **Building the Electron application** and   **Building the Electron application for windows**, the former can lead a beginner to confusion because it seems to be "a generalized statement", unlike the latter that was more specific. In order to improve the developers experience, i had to change the former heading to "Building the Electron application for Linux and macOS" to help them understand easily.

* Implemented advises from Reviewer (tessus) to further improve  the documentation instructions for building the Electron App on Linux, macOS and Windows
This commit is contained in:
Runo Saduwa 2020-01-27 09:16:12 +01:00 committed by Helmut K. C. Tessarek
parent e1216dce4b
commit 2042deb2bf
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
BUILD.md
View File

@ -35,6 +35,8 @@ npm install && cd Tools && npm install
# Building the Electron application
## Linux and macOS
```
npm run copyLib
npm run tsc
@ -53,7 +55,9 @@ That will create the executable file in the `dist` directory.
From `/ElectronClient` you can also run `run.sh` to run the app for testing.
## Building Electron application on Windows
## Windows
Run the following commands on Windows Command prompt running as Administrator:
```
xcopy /C /I /H /R /Y /S ReactNativeClient\lib ElectronClient\app\lib