README.adoc in sublime_text_kit-10.0.2 vs README.adoc in sublime_text_kit-11.0.0

- old
+ new

@@ -9,11 +9,13 @@ [link=https://www.alchemists.io/projects/code_quality] image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide] [link=https://circleci.com/gh/bkuhlmann/sublime_text_kit] image::https://circleci.com/gh/bkuhlmann/sublime_text_kit.svg?style=svg[Circle CI Status] -A command line interface for managing Sublime Text metadata. +Sublime Text Kit is a command line interface for managing Sublime Text metadata for multiple +projects, sessions, etc. It's also great for generating the metadata you need, while avoiding manual +labor, from existing projects. toc::[] == Features @@ -21,15 +23,10 @@ project switching via the `CONTROL+COMMAND+P` shortcut. * Rebuilds project history (Project -> Recent Projects) from existing project files (assumes project metadata is in a directory) so one can easily toggle between up-to-date project information via the `CONTROL+COMMAND+P` shortcut. -== Screencasts - -[link=https://www.alchemists.io/screencasts/sublime_text_kit] -image::https://www.alchemists.io/images/screencasts/sublime_text_kit/cover.svg[Screencast,600,240,role=focal_point] - == Requirements . link:https://www.ruby-lang.org[Ruby] . link:https://www.sublimetext.com[Sublime Text] @@ -47,47 +44,20 @@ === Command Line Interface (CLI) From the command line, type: `sublime_text_kit` .... -sublime_text_kit -c, [--config] # Manage gem configuration. -sublime_text_kit -h, [--help=COMMAND] # Show this message or get help for a command. -sublime_text_kit -m, [--metadata] # Manage project/workspace metadata. -sublime_text_kit -p, [--snippets] # Print user defined snippets. -sublime_text_kit -s, [--session] # Manage session metadata. -sublime_text_kit -u, [--update] # Update Sublime Text with current settings. -sublime_text_kit -v, [--version] # Show gem version. +USAGE: + -c, --config ACTION Manage gem configuration. Actions: edit or view. + -h, --help Show this message. + -m, --metadata ACTION Manage metadata. Actions: create, delete, or recreate. + -S, --session Rebuild session. + -s, --snippets [FORMAT] View snippets. Default: markdown. Formats: markdown or ascii_doc. + -u, --update Update metadata and session based on current settings. + -v, --version Show gem version. .... -For configuration options, type: `sublime_text_kit --help --config` - -.... --e, [--edit], [--no-edit] # Edit gem configuration. --i, [--info], [--no-info] # Print gem configuration. -.... - -For metadata options, type: `sublime_text_kit --help --metadata` - -.... --c, [--create], [--no-create] # Create metadata. --D, [--destroy], [--no-destroy] # Destroy metadata. --R, [--rebuild], [--no-rebuild] # Rebuild metadata. -.... - -For session options, type: `sublime_text_kit --help --session` - -.... --R, [--rebuild], [--no-rebuild] # Rebuild session metadata. -.... - -For snippet options, type: `sublime_text_kit --help --snippets` - -.... --a, [--ascii-doc], [--no-ascii-doc] # Print snippets in ASCII Doc format. --m, [--markdown], [--no-markdown] # Print snippets in Markdown format. -.... - === Customization This gem can be configured via a global configuration: `~/.config/sublime_text_kit/configuration.yml`. It can also be configured via link:https://www.alchemists.io/projects/xdg[XDG] environment variables. @@ -95,14 +65,14 @@ An example configuration could be: [source,yaml] ---- :project_roots: - - "~/Dropbox/Development/Misc" - - "~/Dropbox/Development/OSS" - - "~/Dropbox/Development/Work" + - "~/Engineering/Contributions" + - "~/Engineering/OSS" :metadata_dir: "~/Dropbox/Cache/Sublime" +:snippets_format: :ascii_doc ---- Feel free to take this configuration, modify, and save as your own custom `+configuration.yml+`. The project roots define the root level directories where project folders are located. When project @@ -110,12 +80,12 @@ will be the same name as that of the project folder. All project metadata, regardless of root location, is written to the same metadata directory. If using the example settings shown above and assuming the following directory structure exists… .... -~/Dropbox/Development/Misc/example -~/Dropbox/Development/OSS/sublime_text_kit +~/Engineering/OSS/example +~/Engineering/OSS/sublime_text_kit .... …the project metadata will be created in the workspace directory as follows: .... @@ -130,15 +100,15 @@ The following demonstrates a default Sublime Text setup: . Run: `sublime_text_kit --config --edit` (define Sublime Text Kit settings for project roots and metadata directory). . Shutdown Sublime Text (i.e. `CONTROL+Q`). -. Run: `sublime_text_kit --metadata --create` (creates project metadata and rebuilds the session +. Run: `sublime_text_kit --metadata create` (creates project metadata and rebuilds the session metadata so Sublime Text has a complete project history from which to jump through via the `CONTROL+COMMMAND+P` shortcut). . Launch Sublime Text and use the `CONTROL+COMMAND+P` keyboard shortcut to toggle between projects. Notice that you can (fuzzy type) project names to jump between them. -. Breeze through your project workload with ease. 😉 +. Breeze through your project workload with ease. 🎉 === Troubleshooting * When rebuilding workspaces, ensure Sublime Text is shutdown or changes won’t be applied. * When rebuilding workspaces, ensure workspace_dir (as defined via settings.yml) points to a