From 41c81ed066116e8649548a90661c9c8f830b288c Mon Sep 17 00:00:00 2001 From: Alvin Philips Date: Fri, 4 Mar 2022 05:05:51 +0530 Subject: [PATCH] docs: Updated list numbering (#32991) * docs: Updated list numbering The steps to package and distribute an application using electron had incorrect numbering * Indented text within ordered list sections * Removed single space * Fixed indentation --- docs/tutorial/quick-start.md | 86 ++++++++++++++++++------------------ 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 91c3317d336d6..d7252ac16bfdc 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -463,46 +463,46 @@ The fastest way to distribute your newly created app is using 1. Add Electron Forge as a development dependency of your app, and use its `import` command to set up Forge's scaffolding: -```sh npm2yarn -npm install --save-dev @electron-forge/cli -npx electron-forge import - -✔ Checking your system -✔ Initializing Git Repository -✔ Writing modified package.json file -✔ Installing dependencies -✔ Writing modified package.json file -✔ Fixing .gitignore - -We have ATTEMPTED to convert your app to be in a format that electron-forge understands. - -Thanks for using "electron-forge"!!! -``` - -1. Create a distributable using Forge's `make` command: - -```sh npm2yarn -npm run make - -> my-electron-app@1.0.0 make /my-electron-app -> electron-forge make - -✔ Checking your system -✔ Resolving Forge Config -We need to package your application before we can make it -✔ Preparing to Package Application for arch: x64 -✔ Preparing native dependencies -✔ Packaging Application -Making for the following targets: zip -✔ Making for target: zip - On platform: darwin - For arch: x64 -``` - -Electron Forge creates the `out` folder where your package will be located: - -```plain -// Example for macOS -out/ -├── out/make/zip/darwin/x64/my-electron-app-darwin-x64-1.0.0.zip -├── ... -└── out/my-electron-app-darwin-x64/my-electron-app.app/Contents/MacOS/my-electron-app -``` + ```sh npm2yarn + npm install --save-dev @electron-forge/cli + npx electron-forge import + + ✔ Checking your system + ✔ Initializing Git Repository + ✔ Writing modified package.json file + ✔ Installing dependencies + ✔ Writing modified package.json file + ✔ Fixing .gitignore + + We have ATTEMPTED to convert your app to be in a format that electron-forge understands. + + Thanks for using "electron-forge"!!! + ``` + +2. Create a distributable using Forge's `make` command: + + ```sh npm2yarn + npm run make + + > my-electron-app@1.0.0 make /my-electron-app + > electron-forge make + + ✔ Checking your system + ✔ Resolving Forge Config + We need to package your application before we can make it + ✔ Preparing to Package Application for arch: x64 + ✔ Preparing native dependencies + ✔ Packaging Application + Making for the following targets: zip + ✔ Making for target: zip - On platform: darwin - For arch: x64 + ``` + + Electron Forge creates the `out` folder where your package will be located: + + ```plain + // Example for macOS + out/ + ├── out/make/zip/darwin/x64/my-electron-app-darwin-x64-1.0.0.zip + ├── ... + └── out/my-electron-app-darwin-x64/my-electron-app.app/Contents/MacOS/my-electron-app + ```