Skip to content

Commit

Permalink
Improved docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
guillermooo committed Apr 25, 2011
1 parent de6ea54 commit f71d0c4
Showing 1 changed file with 40 additions and 30 deletions.
70 changes: 40 additions & 30 deletions README.rst
@@ -1,65 +1,64 @@
==========
SublimeCMD
==========

A simple command processor for Sublime Text.


The Problem
***********
===========

The Python console is very cumbersome to use for a number of common tasks. A
dedicated command processor for these task can improve the experience.
dedicated command processor for these tasks can improve the experience.


Feature Overview
****************
================

- Commands to explore settings, commands and keybindings, and to run commands
conveniently by name.
- Integration with PowershellUtils package (if available).
- Integration with UberSelection package (if available).
- Commands to explore settings, commands and keybindings, and to run commands
by name.
- Integration with PowershellUtils package (if available).
- Integration with UberSelection package (if available).


Getting Started
***************

Download the following items:
===============

* \ `Latest release`_ of SublimeCMD.
* \ `AAAPackageDev`_ (dependency).
* Optionally, `UberSelection`_.
* Optionally, `PowershellUtils`_.
* Install `SublimeCMD`_
* Install `AAAPackageDev`_ (dependency)
* Optionally install, `UberSelection`_
* Optionally install, `PowershellUtils`_

.. _Latest release: https://bitbucket.org/guillermooo/sublimecmd/downloads/SublimeCMD.sublime-package
.. _SublimeCMD: https://bitbucket.org/guillermooo/sublimecmd/downloads/SublimeCMD.sublime-package
.. _AAAPackageDev: https://bitbucket.org/guillermooo/aaapackagedev/src
.. _UberSelection: https://bitbucket.org/guillermooo/uberselection/src
.. _PowershellUtils: https://bitbucket.org/guillermooo/powershellutils/src

Install all downloaded ``.sublime-package``\ s:

- If you're running a full installation, simply double click on the file.
- If you're running a portable installation, perform a `manual installation`_.
If you're running a full installation, simply double click on the ``.sublime-package`` files.
If you're running a portable installation, perform an `installation by hand`_.

.. _manual installation: http://sublimetext.info/docs/extensibility/packages.html#installation-of-packages-with-sublime-package-archives
.. _installation by hand: http://sublimetext.info/docs/extensibility/packages.html#installation-of-packages-with-sublime-package-archives

Lastly, run ``sublime_cmd`` from the Python console or bind this command to a
key combination.
key combination::

view.run_command("sublime_cmd")


How to Use
**********
==========

SublimeCMD understands the following types of commands:

* Intrinsic SublimeCMD commands.
* UberSelection commands (see UberSelection docs).
* PowershellUtils commands (see PowershellUtils docs).
* Intrinsic SublimeCMD commands
* UberSelection commands (see UberSelection docs)
* PowershellUtils commands (see PowershellUtils docs)

Type commands at the SublimeCMD prompt and press ``enter``.


Intrinsic Commands
******************
==================

Syntax:

Expand Down Expand Up @@ -125,12 +124,23 @@ This command shows all found commands. Note the argument is ignored.


Powershell Commands
*******************
===================

Precede the command with ``r!``.
Precede the command with ``!`` or ``r!``::

![datetime]"$(([datetime]::Now).year)/12/25"-(date)|%{ "Days left until Christmas: $($_.days)"}
r!"$pwd"

``!``
Runs the command and outputs results to a new buffer.

``r!``
Runs the command and *reads* ouput into selected regions.


UberSelection Commands
**********************
======================

Type the command normally::

Type the command normally.
?^def ?,/^def /-1-V/football/;s/foo/bar/

0 comments on commit f71d0c4

Please sign in to comment.