Browse Source

update the zh-CN docs README.md and find a error in en docs README.md (#7676)

* update the zh-CN readme and find a error in en readme

* fix a style problem
kok liu 8 years ago
parent
commit
52783bb67f
2 changed files with 24 additions and 7 deletions
  1. 23 6
      docs-translations/zh-CN/README.md
  2. 1 1
      docs/README.md

+ 23 - 6
docs-translations/zh-CN/README.md

@@ -1,12 +1,21 @@
+请确认你的使用的文档匹配你的 Electron 版本。你可以在页面的 URL 中找到版本号。
+如果不是,你可能在使用开发分支版本的文档,其中包括了一些与你的 Electron 版本不兼容的 API。
+如果想要访问老版本的文档,你可以通过 GitHub 的[切换分支功能](https://github.com/electron/electron/tree/v1.4.0),在下拉菜单中选择与你的版本匹配的分支。
+
 ## 常见问题
 
-+ [Electron 常见问题](faq/electron-faq.md)
+这里是一些被经常问到的问题,再提 issue 之前请先看一下这里。
+
++ [Electron 常见问题](faq/electron-faq.md) 需要更新
 
 ## 向导
 
 * [支持平台](tutorial/supported-platforms.md)
+* [安全性](tutorial/security.md) 未翻译
+* [Electron 版本管理](tutorial/electron-versioning.md) 未翻译
 * [分发应用](tutorial/application-distribution.md)
 * [提交应用到 Mac App Store](tutorial/mac-app-store-submission-guide.md)
+* [Windows 商店提交指引](tutorial/windows-store-guide.md)
 * [打包应用](tutorial/application-packaging.md)
 * [使用 Node 原生模块](tutorial/using-native-node-modules.md)
 * [主进程调试](tutorial/debugging-main-process.md)
@@ -14,12 +23,15 @@
 * [使用开发人员工具扩展](tutorial/devtools-extension.md)
 * [使用 Pepper Flash 插件](tutorial/using-pepper-flash-plugin.md)
 * [使用 Widevine CDM 插件](tutorial/using-widevine-cdm-plugin.md)
+* [通过自动化持续集成系统(CI)进行测试 (Travis, Jenkins)](tutorial/testing-on-headless-ci.md) 未翻译
+* [离屏渲染](tutorial/offscreen-rendering.md) 未翻译
 
 ## 教程
 
 * [快速入门](tutorial/quick-start.md)
 * [桌面环境集成](tutorial/desktop-environment-integration.md)
 * [在线/离线事件探测](tutorial/online-offline-events.md)
+* [应答式编译器(REPL)](tutorial/repl.md) 未翻译
 
 ## API文档
 
@@ -28,13 +40,13 @@
 * [支持的 Chrome 命令行开关](api/chrome-command-line-switches.md)
 * [环境变量](api/environment-variables.md)
 
-自定义的 DOM 元素:
+### 自定义的 DOM 元素:
 
 * [`File` 对象](api/file-object.md)
 * [`<webview>` 标签](api/web-view-tag.md)
 * [`window.open` 函数](api/window-open.md)
 
-在主进程内可用的模块:
+### 在主进程内可用的模块:
 
 * [app](api/app.md)
 * [autoUpdater](api/auto-updater.md)
@@ -49,17 +61,18 @@
 * [powerSaveBlocker](api/power-save-blocker.md)
 * [protocol](api/protocol.md)
 * [session](api/session.md)
-* [webContents](api/web-contents.md)
+* [systemPreferences](api/system-preferences.md) 未翻译
 * [Tray](api/tray.md)
+* [webContents](api/web-contents.md)
 
-在渲染进程(网页)内可用的模块:
+### 在渲染进程(网页)内可用的模块:
 
 * [desktopCapturer](api/desktop-capturer.md)
 * [ipcRenderer](api/ipc-renderer.md)
 * [remote](api/remote.md)
 * [webFrame](api/web-frame.md)
 
-在两种进程中都可用的模块:
+### 在两种进程中都可用的模块:
 
 * [clipboard](api/clipboard.md)
 * [crashReporter](api/crash-reporter.md)
@@ -70,10 +83,14 @@
 ## 开发
 
 * [代码规范](development/coding-style.md)
+* [在 C++ 代码中试用 clang格式化工具](development/clang-format.md) 未翻译
 * [源码目录结构](development/source-code-directory-structure.md)
 * [与 NW.js(原 node-webkit)在技术上的差异](development/atom-shell-vs-node-webkit.md)
 * [构建系统概览](development/build-system-overview.md)
 * [构建步骤(macOS)](development/build-instructions-osx.md)
 * [构建步骤(Windows)](development/build-instructions-windows.md)
 * [构建步骤(Linux)](development/build-instructions-linux.md)
+* [调试步骤 (macOS)](development/debug-instructions-macos.md) 未翻译
+* [调试步骤 (Windows)](development/debug-instructions-windows.md) 未翻译
 * [在调试中使用 Symbol Server](development/setting-up-symbol-server.md)
+* [文档风格规范](styleguide.md) 未翻译

+ 1 - 1
docs/README.md

@@ -99,4 +99,4 @@ an issue:
 * [Debug Instructions (macOS)](development/debug-instructions-macos.md)
 * [Debug Instructions (Windows)](development/debug-instructions-windows.md)
 * [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md)
-* [Documentation Styleguide](development/styleguide.md)
+* [Documentation Styleguide](styleguide.md)