diff --git a/README-EN.md b/README-EN.md new file mode 100644 index 0000000..c83a3ee --- /dev/null +++ b/README-EN.md @@ -0,0 +1,72 @@ +## Auto-Spacing + +Sublime Text 3 Plugin to automatically insert whitespace between Chinese and English. + +[中文](./README.md) + +## Installation + +### Via Github + +First, clone the repo via git to Sublime's package directory. + +### Via Package Control + +To install via Package Control, do the following: + +Within Sublime Text, bring up the Command Palette and type install. +Among the commands you should see Package Control: Install Package. +If that command is not highlighted, use the keyboard or mouse to select it. +There will be a pause of a few seconds while Package Control fetches the list of available plugins. + +When the plugin list appears, type Auto Spacing. +Among the entries you should see Auto-Spacing. +If that entry is not highlighted, use the keyboard or mouse to select it. + + + +## Commands +**Command palette:** + +- Auto-Spacing: Spacing this file + +**Shortcut key:** + +* Linux/Windows: [Ctrl + Shift + B] +* Mac: [Cmd + Shift + B] + + +## Settings + +By default, Auto-Spacing will supply the following settings: + +```javascript +{ + // Automatically format when a file is saved. + "format_on_save": false, + + // Only attempt to format files with whitelisted extensions on save. + // Leave empty to disable the check + "format_on_save_extensions": [ + "md", + "txt" + ] +} +``` + +* Modify any settings within the `Preferences -> Package Settings -> Auto-Spacing -> Settings - User` file. + +## Contributing + +If you find any bugs feel free to report them [here](https://github.com/xwartz/Auto-Spacing/issues). + +Pull requests are also encouraged. + +### Thanks + +[@vinta](https://github.com/vinta/pangu.py) + + +## License + +MIT diff --git a/README.md b/README.md index 1ce9763..5ecc78e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,56 @@ ## Auto-Spacing -Sublime Text 3 Plugin to automatically insert whitespace between Chinese and English. +Sublime Text 3 插件,给中英文之间加上空格。 -哈哈哈 a 哈哈 aadafadf 哈哈 +为什么你们就是不能加个空格呢,为什么我就是能这样娴熟地加上空格呢。 + +[English](./README-EN.md) + +## 安装 + +### 通过 github + +git clone 这个仓库到 Sublime Text 3 的插件目录下 (Mac 的目录 ~/Library/Application Support/Sublime Text 3/Packages/)。 + +### 通过 sublime 控制台 + +`Ctrl + Shift + P` 选择 `Auto-Spacing`。 + +## Commands +**Command palette:** + +- Auto-Spacing: Spacing this file + +**Shortcut key:** + +* Linux/Windows: [Ctrl + Shift + B] +* Mac: [Cmd + Shift + B] + + +## Settings + +默认设置: + +```javascript +{ + "format_on_save_extensions": false, + [ + "md", + "txt" + ] +} +``` + +* 可自行更改默认设置 `Preferences -> Package Settings -> Auto-Spacing -> Settings - User`。 + +## Contributing + +欢迎提交 PR。 + +### Thanks + +[@vinta](https://github.com/vinta/pangu.py) + +## License + +MIT