README.adoc in sublime_text_kit-14.2.0 vs README.adoc in sublime_text_kit-15.0.0
- old
+ new
@@ -46,18 +46,27 @@
=== Command Line Interface (CLI)
From the command line, type: `sublime_text_kit`
....
-USAGE:
- -c, --config ACTION Manage gem configuration. Actions: edit or view.
- -h, --help Show this message.
- -m, --metadata ACTION Manage project metadata. Actions: create, delete, or recreate.
- -S, --session Rebuild session metadata.
- -s, --snippets [FORMAT] View snippets. Formats: markdown or ascii_doc. Default: ascii_doc.
- -u, --update Update project and session metadata based on current settings.
- -v, --version Show gem version.
+USAGE
+ sublime_text_kit [OPTIONS]
+ sublime_text_kit COMMAND [OPTIONS]
+
+OPTIONS
+ -S, --session Rebuild session metadata.
+ -s, --snippets [FORMAT] View snippets.
+ Use: markdown or ascii_doc.
+ Default: ascii_doc.
+ -u, --update Update project and session metadata based on current settings.
+ -v, --version Show version.
+ -h, --help [COMMAND] Show this message.
+
+COMMANDS
+ config Manage configuration.
+ Path is dynamic per current directory.
+ metadata Manage project metadata.
....
=== Customization
This gem can be configured via a global configuration:
@@ -66,19 +75,17 @@
An example configuration could be:
[source,yaml]
----
-:project_roots:
+project_roots:
- "~/Engineering/Organizations"
- "~/Engineering/OSS"
-:metadata_dir: "~/Dropbox/Cache/Sublime"
-:snippets_format: :markdown
+metadata_dir: "~/Dropbox/Cache/Sublime"
+snippets_format: :markdown
----
-Feel free to take this configuration, modify, and save as your own.
-
The `project_roots` key defines the root level directories where your project folders are located.
When project metadata (i.e. `.sublime-project`, `.sublime-workspace`) is generated, the name of the
metadata file will be the same name as the project folder. All project metadata, regardless of root
location, is written to the same metadata directory as defined by the `metadata_dir` key. If using
the example settings shown above and assuming the following directory structure exists…
@@ -110,10 +117,10 @@
1. Start by defining your configuration: `sublime_text_kit --config edit`.
2. Shutdown Sublime Text (i.e. `COMMAND+q`).
3. Run `sublime_text_kit --update` which will create project metadata and rebuild session metadata
so Sublime Text has a complete project history from which to switch between via the
- `CONTROL+COMMMAND+p` shortcut.
+ `CONTROL+COMMAND+p` shortcut.
4. 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.
5. Navigate through your project workload with ease. 🎉
=== Troubleshooting