chore: change headings in README to Title Case (#11956)

Co-authored-by: Marc Cornellà <hello@mcornella.com>
2024-11-15 01:48:34 -07:00 · 2023-10-12 00:27:01 +05:30 · 2023-10-12 00:27:01 +05:30 · 6768906d07
commit 6768906d07
parent 408330e131
1 changed files with 35 additions and 34 deletions
--- a/README.md
+++ b/README.md
@ -23,32 +23,33 @@ To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twi
 <summary>Table of Contents</summary>

 - [Getting Started](#getting-started)
+  - [Operating System Compatibility](#operating-system-compatibility)
  - [Prerequisites](#prerequisites)
  - [Basic Installation](#basic-installation)
-    - [Manual inspection](#manual-inspection)
+    - [Manual Inspection](#manual-inspection)
 - [Using Oh My Zsh](#using-oh-my-zsh)
  - [Plugins](#plugins)
    - [Enabling Plugins](#enabling-plugins)
    - [Using Plugins](#using-plugins)
  - [Themes](#themes)
-    - [Selecting a Theme](#selecting-a-theme)
+    - [Selecting A Theme](#selecting-a-theme)
  - [FAQ](#faq)
 - [Advanced Topics](#advanced-topics)
  - [Advanced Installation](#advanced-installation)
    - [Custom Directory](#custom-directory)
-    - [Unattended install](#unattended-install)
-    - [Installing from a forked repository](#installing-from-a-forked-repository)
+    - [Unattended Install](#unattended-install)
+    - [Installing From A Forked Repository](#installing-from-a-forked-repository)
    - [Manual Installation](#manual-installation)
  - [Installation Problems](#installation-problems)
-  - [Custom Plugins and Themes](#custom-plugins-and-themes)
-  - [Enable GNU ls in macOS and freeBSD systems](#enable-gnu-ls)
-  - [Skip aliases](#skip-aliases)
+  - [Custom Plugins And Themes](#custom-plugins-and-themes)
+  - [Enable GNU ls In macOS And freeBSD Systems](#enable-gnu-ls-in-macos-and-freebsd-systems)
+  - [Skip Aliases](#skip-aliases)
 - [Getting Updates](#getting-updates)
-  - [Updates verbosity](#updates-verbosity)
+  - [Updates Verbosity](#updates-verbosity)
  - [Manual Updates](#manual-updates)
 - [Uninstalling Oh My Zsh](#uninstalling-oh-my-zsh)
- [How do I contribute to Oh My Zsh?](#how-do-i-contribute-to-oh-my-zsh)
-  - [Do NOT send us themes](#do-not-send-us-themes)
+- [How Do I Contribute To Oh My Zsh?](#how-do-i-contribute-to-oh-my-zsh)
+  - [Do Not Send Us Themes](#do-not-send-us-themes)
 - [Contributors](#contributors)
 - [Follow Us](#follow-us)
 - [Merchandise](#merchandise)
@ -61,15 +62,15 @@ To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twi

 ### Operating System Compatibility

-| O/S    | Status   |
-| :---------------- | :------: |
-| Android        | ✅ |
-| FreeBSD        | ✅ |
-| LCARS          | 🛸 | 
-| Linux          | ✅ |
-| MacOS          | ✅ | 
-| OS/2 Warp      | ❌ |
-| Windows (WSL2) | ✅ |
+| O/S            | Status  |
+| :------------- | :-----: |
+| Android        |   ✅    |
+| freeBSD        |   ✅    |
+| LCARS          |   🛸    |
+| Linux          |   ✅    |
+| macOS          |   ✅    |
+| OS/2 Warp      |   ❌    |
+| Windows (WSL2) |   ✅    |


 ### Prerequisites
@ -90,7 +91,7 @@ Oh My Zsh is installed by running one of the following commands in your terminal

 _Note that any previous `.zshrc` will be renamed to `.zshrc.pre-oh-my-zsh`. After installation, you can move the configuration you want to preserve into the new `.zshrc`._

-#### Manual inspection
+#### Manual Inspection

 It's a good idea to inspect the install script from projects you don't yet know. You can do
 that by downloading the install script first, looking through it so everything looks normal,
@ -139,7 +140,7 @@ Each built-in plugin includes a **README**, documenting it. This README should s

 We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred and fifty themes now bundled. Most of them have [screenshots](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes) on the wiki (We are working on updating this!). Check them out!

-#### Selecting a Theme
+#### Selecting A Theme

 _Robby's theme is the default one. It's not the fanciest one. It's not the simplest one. It's just the right one (for him)._

@ -210,7 +211,7 @@ like this:
 ZSH="$HOME/.dotfiles/oh-my-zsh" sh install.sh
 ```

-#### Unattended install
+#### Unattended Install

 If you're running the Oh My Zsh install script as part of an automated install, you can pass the `--unattended`
 flag to the `install.sh` script. This will have the effect of not trying to change
@ -220,7 +221,7 @@ the default shell, and it also won't run `zsh` when the installation has finishe
 sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended
 ```

-#### Installing from a forked repository
+#### Installing From A Forked Repository

 The install script also accepts these variables to allow installation of a different repository:

@ -245,19 +246,19 @@ REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh

 #### Manual Installation

-##### 1. Clone the repository <!-- omit in toc -->
+##### 1. Clone The Repository <!-- omit in toc -->

 ```sh
 git clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh
 ```

-##### 2. _Optionally_, backup your existing `~/.zshrc` file <!-- omit in toc -->
+##### 2. _Optionally_, Backup Your Existing `~/.zshrc` File <!-- omit in toc -->

 ```sh
 cp ~/.zshrc ~/.zshrc.orig
 ```

-##### 3. Create a new zsh configuration file <!-- omit in toc -->
+##### 3. Create A New Zsh Configuration File <!-- omit in toc -->

 You can create a new zsh config file by copying the template that we have included for you.

@ -265,7 +266,7 @@ You can create a new zsh config file by copying the template that we have includ
 cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc
 ```

-##### 4. Change your default shell <!-- omit in toc -->
+##### 4. Change Your Default Shell <!-- omit in toc -->

 ```sh
 chsh -s $(which zsh)
@ -273,7 +274,7 @@ chsh -s $(which zsh)

 You must log out from your user session and log back in to see this change.

-##### 5. Initialize your new zsh configuration <!-- omit in toc -->
+##### 5. Initialize Your New Zsh Configuration <!-- omit in toc -->

 Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.

@ -284,7 +285,7 @@ If you have any hiccups installing, here are a few common fixes.
 - You _might_ need to modify your `PATH` in `~/.zshrc` if you're not able to find some commands after switching to `oh-my-zsh`.
 - If you installed manually or changed the install location, check the `ZSH` environment variable in `~/.zshrc`.

-### Custom Plugins and Themes
+### Custom Plugins And Themes

 If you want to override any of the default behaviors, just add a new file (ending in `.zsh`) in the `custom/` directory.

@ -292,7 +293,7 @@ If you have many functions that go well together, you can put them as a `XYZ.plu

 If you would like to override the functionality of a plugin distributed with Oh My Zsh, create a plugin of the same name in the `custom/plugins/` directory and it will be loaded instead of the one in `plugins/`.

-### Enable GNU ls in macOS and freeBSD systems
+### Enable GNU ls In macOS And freeBSD Systems

 <a name="enable-gnu-ls"></a>

@ -306,7 +307,7 @@ zstyle ':omz:lib:theme-and-appearance' gnu-ls yes

 _Note: this is not compatible with `DISABLE_LS_COLORS=true`_

-### Skip aliases
+### Skip Aliases

 <a name="remove-directories-aliases"></a>

@ -389,7 +390,7 @@ zstyle ':omz:update' frequency 7
 zstyle ':omz:update' frequency 0
 ```

-### Updates verbosity
+### Updates Verbosity

 You can also limit the update verbosity with the following settings:

@ -417,7 +418,7 @@ Oh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy b

 If you want to uninstall `oh-my-zsh`, just run `uninstall_oh_my_zsh` from the command-line. It will remove itself and revert your previous `bash` or `zsh` configuration.

-## How do I contribute to Oh My Zsh?
+## How Do I Contribute To Oh My Zsh?

 Before you participate in our delightful community, please read the [code of conduct](CODE_OF_CONDUCT.md).

@ -427,7 +428,7 @@ We also need people to test out pull requests. So take a look through [the open

 See [Contributing](CONTRIBUTING.md) for more details.

-### Do NOT send us themes
+### Do Not Send Us Themes

 We have (more than) enough themes for the time being. Please add your theme to the [external themes](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes) wiki page.