From d01435bead49bd7edd9ed07636be9e2cc63734f1 Mon Sep 17 00:00:00 2001 From: Katya Demidova Date: Thu, 14 Jan 2016 04:07:57 +0300 Subject: [PATCH] Tiny improvements --- CONTRIBUTING.md | 4 ++-- README.md | 26 ++++++++++++++------------ docs/en-US/Packages.md | 2 +- 3 files changed, 17 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8633ec0..9609a32 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ If your issue is related to a specific package, we still may be able to help, bu + Use the [present tense](https://simple.wikipedia.org/wiki/Present_tense) ("add awesome-package" not "added ...") -+ Less than 72 characters or less for the first line of your commit. ++ Use 72 characters or less for the first line of your commit. + Use of [emoji](http://www.emoji-cheat-sheet.com/) is definitely encouraged. :lollipop: @@ -80,7 +80,7 @@ function greet -a message -d "Display a greeting message" end ``` -In order to avoid name collisions, use a prefix based on the name of your package. For example, if you are writing a `ninja` package use `ninja.function_name`. +In order to avoid name collisions, use a prefix based on the name of your package. For example, if you are writing a `ninja` package, use `ninja.function_name`. ### Private Functions diff --git a/README.md b/README.md index 06e0371..b743fc0 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![MIT License](https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square)](/LICENSE.md) [![Fish Shell Version](https://img.shields.io/badge/fish-v2.2.0-007EC7.svg?style=flat-square)](http://fishshell.com) [![Travis Build Status](http://img.shields.io/travis/oh-my-fish/oh-my-fish.svg?style=flat-square)](https://travis-ci.org/oh-my-fish/oh-my-fish) [![Slack Status](https://oh-my-fish-slack.herokuapp.com/badge.svg)](https://oh-my-fish-slack.herokuapp.com) -Oh My Fish provides core infrastructure to allow you to install packages which extend or modify the look of your shell. It's fast, extensible and easy to use. +Oh My Fish provides core infrastructure to allow you to install packages which extend or modify the look of your shell. It's fast, extensible and easy to use.

@@ -15,7 +15,7 @@ Oh My Fish provides core infrastructure to allow you to install packages which e 简体中文

-# Install +## Installation ```fish curl -L https://github.com/oh-my-fish/oh-my-fish/raw/master/bin/install | fish @@ -50,7 +50,7 @@ List installed packages. #### `omf theme` _``_ -Apply a theme. To list available themes type `omf theme`. You can also [preview available Themes](./docs/Themes.md) before installing. +Apply a theme. To list available themes, type `omf theme`. You can also [preview available themes](./docs/Themes.md) before installing. #### `omf remove` _``_ @@ -66,29 +66,31 @@ Scaffold out a new package or theme. #### `omf submit` _`pkg/`_ _`[]`_ -Add a new package. To add a theme use `omf submit` _`themes/`_ _``_. +Add a new package. To add a theme, use `omf submit` _`themes/`_ _``_. Make sure to [send us a PR][omf-pulls-link] to update the registry. #### `omf doctor` -Use to troubleshoot before [opening an issue][omf-issues-new]. +Use to troubleshoot before [opening an issue][omf-issues-new]. #### `omf destroy` Uninstall Oh My Fish. -# Advanced +## Advanced Oh My Fish installer places its startup code in your fish config file (`~/.config/fish/config.fish`). -## Startup +### Startup -Every time you open a new shell, the startup code initializes Oh My Fish installation path and the _config_ path (`~/.config/omf` by default), sourcing the [`init.fish`](init.fish) script afterwards, which autoload packages, themes and your custom init files. For more information check the [FAQ](docs/en-US/FAQ.md#what-does-oh-my-fish-do-exactly). +Every time you open a new shell, the startup code initializes Oh My Fish installation path and the _config_ path (`~/.config/omf` by default), sourcing the [`init.fish`](init.fish) script afterwards, which autoloads packages, themes and your custom init files. -## Dotfiles +For more information check the [FAQ](docs/en-US/FAQ.md#what-does-oh-my-fish-do-exactly). -The `$OMF_CONFIG` directory represents the user state of Oh My Fish, and is the perfect +### Dotfiles + +The `$OMF_CONFIG` directory represents the user state of Oh My Fish. It is the perfect candidate for being added to your dotfiles and/or checked out to version control. There are four important files: - __`theme`__ - The current theme @@ -100,9 +102,9 @@ It's highly recommended that your custom startup commands go into `init.fish` fi If you need startup commands to be run *before* Oh My Fish begins loading plugins, place them in `before.init.fish` instead. If you're unsure, it is usually best to put things in `init.fish`. -### About the bundle +#### About the bundle -Every time a package/theme is installed or removed, the `bundle` file is updated. You can also edit it manually and run `omf install` afterwards to satisfy the changes. Please note that while packages/themes added to the bundle get automagically installed, a package/theme removed from bundle isn't removed from user installation. +Every time a package/theme is installed or removed, the `bundle` file is updated. You can also edit it manually and run `omf install` afterwards to satisfy the changes. Please note that while packages/themes added to the bundle get automatically installed, a package/theme removed from bundle isn't removed from user installation. ## Creating Packages diff --git a/docs/en-US/Packages.md b/docs/en-US/Packages.md index ee3ef95..8285da5 100644 --- a/docs/en-US/Packages.md +++ b/docs/en-US/Packages.md @@ -32,7 +32,7 @@ $ ls -l completions/hello_world.fish ``` -Always describe how your package works in the `README.md`. Also read more about [auto completion](http://fishshell.com/docs/current/commands.html#complete) and also take care to provide it for your utilities when applicable. +Always describe how your package works in the `README.md`. Also read more about [auto completion](http://fishshell.com/docs/current/commands.html#complete) and take care to provide it for your utilities when applicable. `hello_world.fish` defines a single function: