At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
| ////////////////////////////////////////////////////////////// | |
| // Font Variables (http://cssfontstack.com/) | |
| ////////////////////////////////////////////////////////////// | |
| // | |
| // Serif font-stacks | |
| // | |
| $baskerville-font-stack: "Big Caslon", "Book Antiqua", "Palatino Linotype", Georgia, serif !default; |
| { | |
| "auto_complete": true, | |
| "auto_complete_commit_on_tab": true, | |
| "auto_complete_with_fields": true, | |
| "bold_folder_labels": true, | |
| "caret_style": "phase", | |
| "color_scheme": "Packages/User/FireCode (SL).tmTheme", | |
| "detect_indentation": true, | |
| "ensure_newline_at_eof_on_save": true, | |
| "fade_fold_buttons": true, |
| // Place your settings in the file "User/Preferences.sublime-settings", which | |
| // overrides the settings in here. | |
| // | |
| // Settings may also be placed in file type specific options files, for | |
| // example, in Packages/Python/Python.sublime-settings for python files. | |
| { | |
| // Sets the colors used within the text area | |
| "color_scheme": "Packages/Color Scheme - Default/Monokai.tmTheme", | |
| // Note that the font_face and font_size are overriden in the platform |
In SublimeLinter 3 you have to install your specific linters. Then each linter needs it's own further installation usually with node or ruby (prob should have those working!)/
SublimeLinter 3 (best installed through package manager) https://github.com/SublimeLinter/SublimeLinter