Browse Source

docs: Add "Supported Platforms"

Cheng Zhao 9 years ago
parent
commit
651009a1dc
3 changed files with 28 additions and 11 deletions
  1. 4 11
      README.md
  2. 1 0
      docs/README.md
  3. 23 0
      docs/tutorial/supported-platforms.md

+ 4 - 11
README.md

@@ -15,7 +15,7 @@ Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
 announcements.
 
 This project adheres to the [Contributor Covenant 1.2](http://contributor-covenant.org/version/1/2/0).
-By participating, you are expected to uphold this code. Please report 
+By participating, you are expected to uphold this code. Please report
 unacceptable behavior to [email protected].
 
 ## Downloads
@@ -38,12 +38,6 @@ npm install electron-prebuilt --save-dev
 
 - [China](https://npm.taobao.org/mirrors/electron)
 
-## Supported Operating Systems
-
-- Ubuntu: 14.04 and higher
-- Mac: OS X 10.8.0 and higher
-- Windows: Win7 or higher
-
 ## Documentation
 
 Guides and the API reference are located in the
@@ -59,15 +53,14 @@ contains documents describing how to build and contribute to Electron.
 - [Simplified Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-CN)
 - [Traditional Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-TW)
 
-
 ## Community
 
-You can ask questions and interact with the community in the following 
+You can ask questions and interact with the community in the following
 locations:
-- [`electron`](http://discuss.atom.io/category/electron) category on the Atom 
+- [`electron`](http://discuss.atom.io/category/electron) category on the Atom
 forums
 - `#atom-shell` channel on Freenode
 - [`Atom`](http://atom-slack.herokuapp.com/) channel on Slack
 
-Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron) 
+Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron)
 for a community maintained list of useful example apps, tools and resources.

+ 1 - 0
docs/README.md

@@ -1,5 +1,6 @@
 ## Guides
 
+* [Supported Platforms](tutorial/supported-platforms.md)
 * [Application Distribution](tutorial/application-distribution.md)
 * [Application Packaging](tutorial/application-packaging.md)
 * [Using Native Node Modules](tutorial/using-native-node-modules.md)

+ 23 - 0
docs/tutorial/supported-platforms.md

@@ -0,0 +1,23 @@
+# Supported Platforms
+
+Following platforms are supported by Electron:
+
+### OS X
+
+Only 64bit binaries are provided for OS X, and the minimum OS X version supported is OS X 10.8.
+
+### Windows
+
+Windows 7 and later are supported, Electron should be able to run on Windows Vista, but there is no testing done on it.
+
+Both `x86` and `x64` binaries are provided for Windows, and `ARM` version of Windows is not supported for now.
+
+### Linux
+
+The prebuilt `ia32`(`i686`) and `x64`(`amd64`) binaries of Electron are built on Ubuntu 12.04, the `arm` binary is built against ARM v7 with hard-float ABI and NEON for Debian Wheezy.
+
+Whether the prebuilt binary can run on a distribution depends on whether the distribution includes the libraries that Electron is linked to on the building platform, so only Ubuntu 12.04 is guaranteed to work, but following platforms are also verified to be able to run the prebuilt binaries of Electron:
+
+* Ubuntu 12.04 and later
+* Fedora 21
+* Debian 8