diff --git a/docs/README.md b/docs/README.md index 37ef74b46347..7fb1fb9afc86 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,27 +18,20 @@ an issue: ## Guides and Tutorials -* [Setting up the Development Environment](tutorial/development-environment.md) - * [Setting up macOS](tutorial/development-environment.md#setting-up-macos) - * [Setting up Windows](tutorial/development-environment.md#setting-up-windows) - * [Setting up Linux](tutorial/development-environment.md#setting-up-linux) - * [Choosing an Editor](tutorial/development-environment.md#a-good-editor) -* [Creating your First App](tutorial/quick-start.md) +### Quickstart + +* [Quick Start Guide](tutorial/quick-start.md) * [Prerequisites](tutorial/quick-start.md#prerequisites) * [Create a basic application](tutorial/quick-start.md#create-a-basic-application) + * [Run your application](tutorial/quick-start.md#run-your-application) * [Package and distribute the application](tutorial/quick-start.md#package-and-distribute-the-application) -* [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md) - * [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli) - * [electron-forge](tutorial/boilerplates-and-clis.md#electron-forge) - * [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder) - * [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate) - * [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates) -* [Application Architecture](tutorial/quick-start.md#application-architecture) + +### Learning the basics + +* [Electron's Process Model](tutorial/quick-start.md#application-architecture) * [Main and Renderer Processes](tutorial/quick-start.md#main-and-renderer-processes) * [Electron API](tutorial/quick-start.md#electron-api) * [Node.js API](tutorial/quick-start.md#nodejs-api) - * [Using Native Node.js Modules](tutorial/using-native-node-modules.md) - * [Performance Strategies](tutorial/performance.md) * Adding Features to Your App * [Notifications](tutorial/notifications.md) * [Recent Documents](tutorial/recent-documents.md) @@ -53,9 +46,20 @@ an issue: * [Offscreen Rendering](tutorial/offscreen-rendering.md) * [Dark Mode](tutorial/dark-mode.md) * [Web embeds in Electron](tutorial/web-embeds.md) +* [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md) + * [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli) + * [electron-forge](tutorial/boilerplates-and-clis.md#electron-forge) + * [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder) + * [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate) + * [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates) + +### Advanced steps + +* Application Architecture + * [Using Native Node.js Modules](tutorial/using-native-node-modules.md) + * [Performance Strategies](tutorial/performance.md) + * [Security Strategies](tutorial/security.md) * [Accessibility](tutorial/accessibility.md) - * [Spectron](tutorial/accessibility.md#spectron) - * [Devtron](tutorial/accessibility.md#devtron) * [Manually Enabling Accessibility Features](tutorial/accessibility.md#manually-enabling-accessibility-features) * [Testing and Debugging](tutorial/application-debugging.md) * [Debugging the Main Process](tutorial/debugging-main-process.md) @@ -70,11 +74,6 @@ an issue: * [Mac App Store](tutorial/mac-app-store-submission-guide.md) * [Windows Store](tutorial/windows-store-guide.md) * [Snapcraft](tutorial/snapcraft.md) -* [Security](tutorial/security.md) - * [Reporting Security Issues](tutorial/security.md#reporting-security-issues) - * [Chromium Security Issues and Upgrades](tutorial/security.md#chromium-security-issues-and-upgrades) - * [Electron Security Warnings](tutorial/security.md#electron-security-warnings) - * [Security Checklist](tutorial/security.md#checklist-security-recommendations) * [Updates](tutorial/updates.md) * [Deploying an Update Server](tutorial/updates.md#deploying-an-update-server) * [Implementing Updates in Your App](tutorial/updates.md#implementing-updates-in-your-app) diff --git a/docs/tutorial/development-environment.md b/docs/tutorial/development-environment.md deleted file mode 100644 index b99a0ff20e3b..000000000000 --- a/docs/tutorial/development-environment.md +++ /dev/null @@ -1,117 +0,0 @@ -# Developer Environment - -Electron development is essentially Node.js development. To turn your operating -system into an environment capable of building desktop apps with Electron, -you will merely need Node.js, npm, a code editor of your choice, and a -rudimentary understanding of your operating system's command line client. - -## Setting up macOS - -> Electron supports macOS 10.10 (Yosemite) and up. Apple -does not allow running macOS in virtual machines unless the host computer is -already an Apple computer, so if you find yourself in need of a Mac, consider -using a cloud service that rents access to Macs (like [MacInCloud][macincloud] -or [xcloud](https://xcloud.me)). - -First, install a recent version of Node.js. We recommend that you install -either the latest `LTS` or `Current` version available. Visit -[the Node.js download page][node-download] and select the `macOS Installer`. -While Homebrew is an offered option, but we recommend against it - many tools -will be incompatible with the way Homebrew installs Node.js. - -Once downloaded, execute the installer and let the installation wizard guide -you through the installation. - -Once installed, confirm that everything works as expected. Find the macOS -`Terminal` application in your `/Applications/Utilities` folder (or by -searching for the word `Terminal` in Spotlight). Open up `Terminal` -or another command line client of your choice and confirm that both `node` -and `npm` are available: - -```sh -# This command should print the version of Node.js -node -v - -# This command should print the version of npm -npm -v -``` - -If both commands printed a version number, you are all set! Before you get -started, you might want to install a [code editor](#a-good-editor) suited -for JavaScript development. - -## Setting up Windows - -> Electron supports Windows 7 and later versions – attempting to develop Electron -applications on earlier versions of Windows will not work. Microsoft provides -free [virtual machine images with Windows 10][windows-vm] for developers. - -First, install a recent version of Node.js. We recommend that you install -either the latest `LTS` or `Current` version available. Visit -[the Node.js download page][node-download] and select the `Windows Installer`. -Once downloaded, execute the installer and let the installation wizard guide -you through the installation. - -On the screen that allows you to configure the installation, make sure to -select the `Node.js runtime`, `npm package manager`, and `Add to PATH` -options. - -Once installed, confirm that everything works as expected. Find the Windows -PowerShell by opening the Start Menu and typing `PowerShell`. Open -up `PowerShell` or another command line client of your choice and confirm that -both `node` and `npm` are available: - -```powershell -# This command should print the version of Node.js -node -v - -# This command should print the version of npm -npm -v -``` - -If both commands printed a version number, you are all set! Before you get -started, you might want to install a [code editor](#a-good-editor) suited -for JavaScript development. - -## Setting up Linux - -> Generally speaking, Electron supports Ubuntu 12.04, Fedora 21, Debian 8 -and later. - -First, install a recent version of Node.js. Depending on your Linux -distribution, the installation steps might differ. Assuming that you normally -install software using a package manager like `apt` or `pacman`, use the -official [Node.js guidance on installing on Linux][node-package]. - -You're running Linux, so you likely already know how to operate a command line -client. Open up your favorite client and confirm that both `node` and `npm` -are available globally: - -```sh -# This command should print the version of Node.js -node -v - -# This command should print the version of npm -npm -v -``` - -If both commands printed a version number, you are all set! Before you get -started, you might want to install a [code editor](#a-good-editor) suited -for JavaScript development. - -## A Good Editor - -We might suggest two free popular editors built in Electron: -GitHub's [Atom][atom] and Microsoft's [Visual Studio Code][code]. Both of -them have excellent JavaScript support. - -If you are one of the many developers with a strong preference, know that -virtually all code editors and IDEs these days support JavaScript. - -[macincloud]: https://www.macincloud.com/ -[xcloud]: https://xcloud.me -[node-download]: https://nodejs.org/en/download/ -[node-package]: https://nodejs.org/en/download/package-manager/ -[atom]: https://atom.io/ -[code]: https://code.visualstudio.com/ -[windows-vm]: https://developer.microsoft.com/en-us/windows/downloads/virtual-machines