From 683e02fbcdd8767d9e5141558a1c4d8559a5a286 Mon Sep 17 00:00:00 2001 From: Felix Rieseberg Date: Mon, 19 Feb 2018 18:09:58 -0600 Subject: [PATCH] :memo: TIE IT ALL TOGETHER --- docs/README.md | 106 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 79 insertions(+), 27 deletions(-) diff --git a/docs/README.md b/docs/README.md index e0e8b153ae..a2cfbfba42 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,35 +14,87 @@ an issue: * [Electron FAQ](faq.md) -## Guides +## 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/first-app.md) + * [Installing Electron](tutorial/first-app.md#installing-electron) + * [Electron Development in a Nutshell](tutorial/first-app.md#electron-development-in-a-nutshell) + * [Running Your App](tutorial/first-app.md#running-your-app) +* [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/application-architecture.md) + * [Main and Renderer Processes](tutorial/application-architecture.md#main-and-renderer-processes) + * [Using Electron's APIs](tutorial/application-architecture.md#using-electron-apis) + * [Using Node.js APIs](tutorial/application-architecture.md#using-node.js-apis) + * [Using Native Node.js Modules](tutorial/using-native-node-modules.md) + * [Inter-Process Communication](tutorial/application-architecture.md#) +* [Adding Features to Your App]() + * [Notifications](tutorial/notifications.md) + * [Recent Documents](tutorial/desktop-environment-integration.md#recent-documents-windows-mac-os) + * [Progress](tutorial/progress-bar.md) + * [Custom Dock Menu](tutorial/desktop-environment-integration.md#custom-dock-menu-mac-os) + * [Custom Windows Taskbar](tutorial/windows-taskbar.md) + * [Custom Unity Launcher](tutorial/unity-launcher.md) + * [Keyboard Shortcuts](tutorial/keyboard-shortcuts.md) + * [Offline/Online Detection](tutorial/online-offline-events.md) +* [Application Accessibility](tutorial/accessibility.md) + * [Spectron](tutorial/accessibility.md#spectron) + * [Devtron](tutorial/accessibility.md#devtron) + * [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility) +* [Application Distribution](tutorial/application-distribution.md) + * [Mac App Store](tutorial/mac-app-store-submission-guide.md) + * [Windows Store](tutorial/windows-store-guide.md) + * [Snapcraft](tutorial/snapcraft.md) + * [Supported Platforms](tutorial/supported-platforms.md) +* [Application 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) +* [Application 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) + * [Applying Updates](tutorial/updates.md#applying-updates) +* [Application Debugging](tutorial/application-debugging.md) + * [Debugging the Main Process](tutorial/debugging-main-process.md) + * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md) + * [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md) + * [DevTools Extension](tutorial/devtools-extension.md) + +## Detailed Tutorials + +These individual tutorial expand on topics discussed in the guide above. + +* [In Detail: Installing Electron](tutorial/installation.md) + * [Global versus Local Installation](tutorial/installation.md#global-versus-local-installation) + * [Proxies](tutorial/installation.md#proxies) + * [Custom Mirrors and Caches](tutorial/installation.md#custom-mirrors-and-caches) + * [Troubleshooting](tutorial/installation.md#troubleshooting) +* [In Detail: Electron's Versioning Scheme](tutorial/electron-versioning.md) + * [semver](tutorial/electron-versioning.md#semver) + * [Stabilization Branches](tutorial/electron-versioning.md#stabilization-branches) + * [Beta Releases and Bug Fixes](tutorial/electron-versioning.md#beta-releases-and-bug-fixes) +* [In Detail: Packaging App Source Code with asar](tutorial/application-packaging.md) + * [Generating asar Archives](tutorial/application-packaging.md#generating-asar-archives) + * [Using asar Archives](tutorial/application-packaging.md#using-asar-archives) + * [Limitations](tutorial/application-packaging.md#limitations-of-the-node-api) + * [Adding Unpacked Files to asar Archives](tutorial/application-packaging.md#adding-unpacked-files-to-asar-archives) +* [In Detail: Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md) +* [In Detail: Using Widevine CDM Plugin](tutorial/using-widevine-cdm-plugin.md) +* [Offscreen Rendering](tutorial/offscreen-rendering.md) + +____ * [Glossary of Terms](glossary.md) -* [Supported Platforms](tutorial/supported-platforms.md) -* [Security](tutorial/security.md) -* [Versioning](tutorial/electron-versioning.md) -* [Application Distribution](tutorial/application-distribution.md) -* [Mac App Store Submission Guide](tutorial/mac-app-store-submission-guide.md) -* [Windows Store Guide](tutorial/windows-store-guide.md) -* [Snapcraft Guide](tutorial/snapcraft-guide.md) -* [Application Packaging](tutorial/application-packaging.md) -* [Using Native Node Modules](tutorial/using-native-node-modules.md) -* [Debugging Main Process](tutorial/debugging-main-process.md) -* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md) -* [DevTools Extension](tutorial/devtools-extension.md) -* [Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md) -* [Using Widevine CDM Plugin](tutorial/using-widevine-cdm-plugin.md) -* [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md) -* [Offscreen Rendering](tutorial/offscreen-rendering.md) -* [Keyboard Shortcuts](tutorial/keyboard-shortcuts.md) -* [Updating Applications](tutorial/updates.md) - -## Tutorials - -* [Quick Start](tutorial/quick-start.md) -* [Desktop Environment Integration](tutorial/desktop-environment-integration.md) -* [Online/Offline Event Detection](tutorial/online-offline-events.md) -* [REPL](tutorial/repl.md) -* [Native Notifications](tutorial/notifications.md) ## API References