diff --git a/README.md b/README.md index d77b5be5..a6a7c84d 100644 --- a/README.md +++ b/README.md @@ -12,63 +12,46 @@ [![License](https://img.shields.io/badge/license-Apache%202.0%20%7C%20BSD%20%7C%20MIT-ba68c8.svg?style=flat-square)][naomi] [![Downloads](https://img.shields.io/packagecontrol/dt/Naomi.svg?style=flat-square)][package-control] -## Installation +Enhanced syntax definitions and doc shortcuts for Sublime Text 3. -#### Manual installation +[![preview](art/main-preview.png)][naomi] -Clone the repository in your Sublime Text “Packages” directory: +## What’s included - git clone https://github.com/borela/naomi.git Naomi +### Color Schemes -The “Packages” directory is located at: +* Candyman; -* **OS X**: `~/Library/Application Support/Sublime Text 3/Packages` -* **Linux**: `~/.config/sublime-text-3/Packages` -* **Windows**: `%APPDATA%\Sublime Text 3\Packages` +### Syntaxes -#### Installing using Package Control +* CSS 3+; +* Git config; +* Git ignore; +* JavaScript; + * [Stage 0-3 proposals](//github.com/tc39/proposals); + * [Node globals](//nodejs.org/api/globals.html); + * [Jest globals](//facebook.github.io/jest/docs/en/api.html); + * [Flow](//flow.org); + * [JSX](//reactjs.org/docs/introducing-jsx.html); +* Git attributes; +* HTML 5+ +* MQL4 (Updating); +* Jest Snapshot; +* PHP 7+ (Updating); +* SCSS (Updating); -1. Install [Package Control](https://packagecontrol.io/installation). -2. Run **Package Control: Install Package** command. -3. Find and install the **Naomi** plugin. -4. Restart Sublime Text if there are issues. +### Enhanced Go To Symbol -## Usage +Go to symbol with emojis: -Go to the menu `View / Syntax / Naomi / ...` to select the new syntax. +[![go-to-symbol](art/go-to-symbol.png)][naomi] -### Sublime Linter +### Mac’s curly quotes for Windows and Linux -To enable [Sublime Linter][sublimeLinter] with the syntaxes available, you need to: - -1. Go to the menu `Preferences / Package Settings / SublimeLinter / Settings - User `. -2. Add these entries to the `syntax_map`: - -```JSON -{ - "syntax_map": { - "naomi.fjsx15": "javascript", - "naomi.html5": "html", - "naomi.mql4": "mql", - "naomi.php7": "php", - "naomi.scss3": "scss" - } -} -``` - -## Features - -### Syntaxes: - -* FJSX15 (Combines ES2015+, Flow, React’s JSX). -* HTML 5. -* SCSS3. -* MQL4. -* PHP 7. - -### Enhanced go to symbol - -![Enhanced go to symbol](preview/go-to-symbol.png) +* `Alt+[` produces “. +* `Alt+Shift+[` produces ”. +* `Alt+]` produces ‘. +* `Alt+Shift+]` produces ’. ### Docblock shortcuts @@ -83,18 +66,39 @@ To enable [Sublime Linter][sublimeLinter] with the syntaxes available, you need * `Backspace` deletes the current line and goes to the previous one. ![Single line docblock preview](preview/single-line.gif) -### Mac’s curly quotes for windows and Linux +## Installation -* `Alt+[` produces “. -* `Alt+Shift+[` produces ”. -* `Alt+]` produces ‘. -* `Alt+Shift+]` produces ’. +#### Manual installation + +Clone the repository in your Sublime Text “Packages” directory: + + git clone https://github.com/borela/naomi.git Naomi + +The “Packages” directory is located at: + +* **OS X**: `~/Library/Application Support/Sublime Text 3/Packages` +* **Linux**: `~/.config/sublime-text-3/Packages` +* **Windows**: `%APPDATA%\Sublime Text 3\Packages` + +#### Installing using Package Control + +1. Install [Package Control](https://packagecontrol.io/installation). +2. Run **Package Control: Install Package** command. +3. Find and install the **Naomi** plugin. +4. Restart Sublime Text. + +## Usage + +To the use syntaxes available you can: -## Preview + 1. Go to the “View” menu; + 2. Then “Syntax”; + 3. Finally “Naomi”; -#### FJSX15 (ES2015 + FlowType + React’s JSX) +Or: -![Candyman FJSX15 preview](preview/fjsx15/candyman.png) + 1. Click at the bottom right corner where it shows the current syntax; + 2. Then “Naomi”. [candyman]: schemes/candyman [package-control]: //packagecontrol.io/packages/Naomi diff --git a/art/go-to-symbol.png b/art/go-to-symbol.png new file mode 100644 index 00000000..a94e590b Binary files /dev/null and b/art/go-to-symbol.png differ diff --git a/art/multiline.gif b/art/multiline.gif new file mode 100644 index 00000000..b6be5a03 Binary files /dev/null and b/art/multiline.gif differ diff --git a/art/single-line.gif b/art/single-line.gif new file mode 100644 index 00000000..5003bcaf Binary files /dev/null and b/art/single-line.gif differ diff --git a/messages/install.txt b/messages/install.txt index f2ac1c0a..1802ab24 100644 --- a/messages/install.txt +++ b/messages/install.txt @@ -4,9 +4,8 @@ | |\ || (_| || (_) || | | | | || | |_| \_| \__,_| \___/ |_| |_| |_||_| -Congratulations on installing the most accurate and actively maintained -syntax definitions! Please, if you find any bugs, don’t hesitate to report -it: +Congratulations on installing Naomi! If you find any bug, don’t hesitate to +report it: https://github.com/borela/naomi/issues @@ -20,15 +19,3 @@ Or: 1. Click at the bottom right corner where it shows the current syntax; 2. Then “Naomi”. - -Or: - - 1. Press “Ctrl+Shift+P”; - 2. Type “set syntax”; - 3. Type the name of one of the available syntaxes: - * CSS 3 - * HTML 5 - * Jest Snapshot - * FJSX15 - * PHP 7 - * SCSS 3