Tidied README

dennykorsukewitz · Nov 24, 2023 · 3cb198b · 3cb198b
1 parent 6044e56
commit 3cb198b
Showing 1 changed file with 29 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -26,33 +26,33 @@ The following files can be created.
 
 | Generator   | Files                           | Function |
 |:------------|:--------------------------------|:--------------|
-| app         | .gitattributes                  | A gitattributes file is a simple text file that gives attributes to pathnames. |
-|             | .gitignore                      | A gitignore file specifies intentionally untracked files that Git should ignore. |
-|             | messages/changelog.txt          | All notable changes to your new package will be documented in this file. |
-|             | messages/install.txt            | When a package is installed, if the key install is present in the messages.json file, the value will be used as the file path to a txt file containing a message to display the user. |
-|             | messages/version.txt            | When a package is upgraded, Package Control looks through each key in the messages.json file sand shows the content of the text file that is a value of any key that is higher than the previous version of the package the user has installed. |
-|             | messages.json                   | Messaging is controlled by a file named messages.json in the root of the package. |
-| commands    | SublimePackage.sublime-commands | SublimePackage.sublime-commands is a file to register your new command / plugin for the Command Palette. |
-| keymap      | Default.sublime-keymap                            | Creates a Default.sublime-keymap file. Default.sublime-keymap files contain the key bindings (shortcuts) for a command. The JSON objects must contain a keys and command key, and may also contain a args key if the command requires arguments. |
-|             | Default (Linux).sublime-keymap   | Shortcuts for Linux |
-|             | Default (OSX).sublime-keymap     | Shortcuts for OSX |
-|             | Default (Windows).sublime-keymap | Shortcuts for Windows |
-| menu        | Context.sublime-menu             | Right click on main buffer. |
-|             | Encoding.sublime-menu            | Left click on "Encoding" section in statusbar. |
-|             | Find in Files.sublime-menu       | Left click on "..." button on Where field of Find_in_files. |
-|             | Indentation.sublime-menu         | Left click on "Indentation" section in statusbar. |
-|             | Line Endings.sublime-menu        | Left click on "Line Ending" section in statusbar. |
-|             | Main.sublime-menu                | Main Menu bar. |
-|             | Side Bar.sublime-menu            | Right click on items in Sidebar. |
-|             | Syntax.sublime-menu              | Left click on current syntax section in statusbar e.g. 'Plain Text'. |
-|             | Side Bar Mount Point.sublime-menu| Right click on main folders in Sidebar. |
-|             | Tab Context.sublime-menu         | Right click on Tab bar. |
-|             | Widget Context.sublime-menu      | Right click on text field of any widget (i.e: search panel or output panel). |
-| plugin      | SublimePackage.py               | Creates a new python plugin. |
-|             | SublimePackage.sublime-settings | Creates a SublimePackage.sublime-settings file to stores configuration data. |
-| readme      | README.md                       | A README is often the first item a visitor will see when visiting your repository.|
-| settings    | SublimePackage.sublime-settings | Creates a SublimePackage.sublime-settings file to stores configuration data. |
-| snippets    | snipptes/SublimePackage.sublime-snippet | Snippets are smart templates that will insert text for you, adapting it to their context. |
+| **app**         | .gitattributes                  | A gitattributes file is a simple text file that gives attributes to pathnames. |
+|                 | .gitignore                      | A gitignore file specifies intentionally untracked files that Git should ignore. |
+|                 | messages/changelog.txt          | All notable changes to your new package will be documented in this file. |
+|                 | messages/install.txt            | When a package is installed, if the key install is present in the messages.json file, the value will be used as the file path to a txt file containing a message to display the user. |
+|                 | messages/version.txt            | When a package is upgraded, Package Control looks through each key in the messages.json file sand shows the content of the text file that is a value of any key that is higher than the previous version of the package the user has installed. |
+|                 | messages.json                   | Messaging is controlled by a file named messages.json in the root of the package. |
+| **commands**    | SublimePackage.sublime-commands | SublimePackage.sublime-commands is a file to register your new command / plugin for the Command Palette. |
+| **keymap**      | Default.sublime-keymap                            | Creates a Default.sublime-keymap file. Default.sublime-keymap files contain the key bindings (shortcuts) for a command. The JSON objects must contain a keys and command key, and may also contain a args key if the command requires arguments. |
+|                 | Default (Linux).sublime-keymap   | Shortcuts for Linux |
+|                 | Default (OSX).sublime-keymap     | Shortcuts for OSX |
+|                 | Default (Windows).sublime-keymap | Shortcuts for Windows |
+| **menu**        | Context.sublime-menu             | Right click on main buffer. |
+|                 | Encoding.sublime-menu            | Left click on "Encoding" section in statusbar. |
+|                 | Find in Files.sublime-menu       | Left click on "..." button on Where field of Find_in_files. |
+|                 | Indentation.sublime-menu         | Left click on "Indentation" section in statusbar. |
+|                 | Line Endings.sublime-menu        | Left click on "Line Ending" section in statusbar. |
+|                 | Main.sublime-menu                | Main Menu bar. |
+|                 | Side Bar.sublime-menu            | Right click on items in Sidebar. |
+|                 | Syntax.sublime-menu              | Left click on current syntax section in statusbar e.g. 'Plain Text'. |
+|                 | Side Bar Mount Point.sublime-menu| Right click on main folders in Sidebar. |
+|                 | Tab Context.sublime-menu         | Right click on Tab bar. |
+|                 | Widget Context.sublime-menu      | Right click on text field of any widget (i.e: search panel or output panel). |
+| **plugin**      | SublimePackage.py               | Creates a new python plugin. |
+|                 | SublimePackage.sublime-settings | Creates a SublimePackage.sublime-settings file to stores configuration data. |
+| **readme**      | README.md                       | A README is often the first item a visitor will see when visiting your repository.|
+| **settings**    | SublimePackage.sublime-settings | Creates a SublimePackage.sublime-settings file to stores configuration data. |
+| **snippets**    | snipptes/SublimePackage.sublime-snippet | Snippets are smart templates that will insert text for you, adapting it to their context. |
 
 ---
 
@@ -140,16 +140,13 @@ npm link ./
 ### Dependencies
 
 ```bash
-# install yeoman-test for jest tests
+# install yeoman-test and yeoman-assert for jest tests
 npm install -g yeoman-test
 npm install -g yeoman-assert
 
-# install eslint
+# install eslint and ejs-lint for linting
 npm install -g eslint
-
-# install ejs-lint
 npm install -g ejs-lint
-
 ```
 
 ### Commands