github-mirror/oh-my-fish
github-mirror/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2025-02-23 03:22:11 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: Add two more levels to comands headings

Browse Source
This commit is contained in:
Derek Stavis 2015-09-06 02:38:03 -03:00
parent 973766526b
commit 0e01737aa0
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -28,48 +28,48 @@ chmod +x install
Oh My Fish includes a small utility `omf` to fetch and install new packages and themes. Oh My Fish includes a small utility `omf` to fetch and install new packages and themes.
## `omf update` #### `omf update`
Update the framework and installed packages. Update the framework and installed packages.
## `omf install` _`[<name>|<url>]`_ #### `omf install` _`[<name>|<url>]`_
Install one _or more_ packages. Install one _or more_ packages.
- You can install packages directly by URL via `omf install URL` - You can install packages directly by URL via `omf install URL`
- When called without arguments, install missing packages from [bundle](#dotfiles). - When called without arguments, install missing packages from [bundle](#dotfiles).
## `omf list` #### `omf list`
List installed packages. List installed packages.
## `omf theme` _`<theme>`_ #### `omf theme` _`<theme>`_
Apply a theme. To list available themes type `omf theme`. Apply a theme. To list available themes type `omf theme`.
## `omf remove` _`<name>`_ #### `omf remove` _`<name>`_
Remove a theme or package. Remove a theme or package.
> Packages subscribed to `uninstall_<pkg>` events are notified before the package is removed, so custom cleanup of resources can be done. See [Uninstall](/docs/Packages.md#uninstall) for more information. > Packages subscribed to `uninstall_<pkg>` events are notified before the package is removed, so custom cleanup of resources can be done. See [Uninstall](/docs/Packages.md#uninstall) for more information.
## `omf new pkg | theme` _`<name>`_ #### `omf new pkg | theme` _`<name>`_
Scaffold out a new package or theme. Scaffold out a new package or theme.
> This creates a new directory under `$OMF_CONFIG/{pkg | themes}/` with a template. > This creates a new directory under `$OMF_CONFIG/{pkg | themes}/` with a template.
## `omf submit` _`pkg/<name>`_ _`[<url>]`_ #### `omf submit` _`pkg/<name>`_ _`[<url>]`_
Add a new package. To add a theme use `omf submit` _`themes/<name>`_ _`<url>`_. Add a new package. To add a theme use `omf submit` _`themes/<name>`_ _`<url>`_.
Make sure to [send us a PR][omf-pulls-link] to update the registry. Make sure to [send us a PR][omf-pulls-link] to update the registry.
## `omf query` _`<variable name>`_ #### `omf query` _`<variable name>`_
Use to inspect all session variables. Useful to dump _path_ variables like `$fish_function_path`, `$fish_complete_path`, `$PATH`, etc. Use to inspect all session variables. Useful to dump _path_ variables like `$fish_function_path`, `$fish_complete_path`, `$PATH`, etc.
## `omf destroy` #### `omf destroy`
Uninstall Oh My Fish. Uninstall Oh My Fish.