From 7af9f41d93dfeda7a73d0116ffeddcf2dcda7e8a Mon Sep 17 00:00:00 2001 From: Bhavishya Pandit <50860603+bhav09@users.noreply.github.com> Date: Sat, 13 Mar 2021 05:28:10 +0530 Subject: [PATCH] #N/A: Add a Contents section to README (#1174) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Pablo Aguiar Co-authored-by: Pablo Aguiar --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 532df6be..b02751bc 100644 --- a/README.md +++ b/README.md @@ -91,12 +91,27 @@ Reading package lists... Done ... ``` +## Contents + +1. [Requirements](https://github.com/bhav09/thefuck#requirements) +2. [Installations](https://github.com/bhav09/thefuck#installation) +3. [Updating](https://github.com/bhav09/thefuck#updating) +4. [How it works](https://github.com/bhav09/thefuck#how-it-works) +5. [Creating your own rules](https://github.com/bhav09/thefuck#creating-your-own-rules) +6. [Settings](https://github.com/bhav09/thefuck#settings) +7. [Third party packages with rules](https://github.com/bhav09/thefuck#third-party-packages-with-rules) +8. [Experimental instant mode](https://github.com/bhav09/thefuck#experimental-instant-mode) +9. [Developing](https://github.com/bhav09/thefuck#developing) +10. [License](https://github.com/bhav09/thefuck#license-mit) + ## Requirements - python (3.4+) - pip - python-dev +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + ## Installation On OS X, you can install *The Fuck* via [Homebrew][homebrew] (or via [Linuxbrew][linuxbrew] on Linux): @@ -157,6 +172,8 @@ To fix commands recursively until succeeding, use the `-r` option: fuck -r ``` +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + ## Updating ```bash @@ -313,6 +330,8 @@ following rules are enabled by default: * `yarn_command_replaced` – fixes replaced `yarn` commands; * `yarn_help` – makes it easier to open `yarn` documentation; +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + The following rules are enabled by default on specific platforms only: * `apt_get` – installs app from apt if it not installed (requires `python-commandnotfound` / `python3-commandnotfound`); @@ -340,6 +359,8 @@ default: * `git_push_force` – adds `--force-with-lease` to a `git push` (may conflict with `git_push_pull`); * `rm_root` – adds `--no-preserve-root` to `rm -rf /` command. +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + ## Creating your own rules To add your own rule, create a file named `your-rule-name.py` @@ -393,6 +414,8 @@ requires_output = True [utility functions for rules](https://github.com/nvbn/thefuck/tree/master/thefuck/utils.py), [app/os-specific helpers](https://github.com/nvbn/thefuck/tree/master/thefuck/specific/). +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + ## Settings Several *The Fuck* parameters can be changed in the file `$XDG_CONFIG_HOME/thefuck/settings.py` @@ -456,6 +479,8 @@ export THEFUCK_HISTORY_LIMIT='2000' export THEFUCK_NUM_CLOSE_MATCHES='5' ``` +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + ## Third-party packages with rules If you'd like to make a specific set of non-public rules, but would still like @@ -475,6 +500,8 @@ thefuck_contrib_foo *The Fuck* will find rules located in the `rules` module. +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + ## Experimental instant mode The default behavior of *The Fuck* requires time to re-run previous commands. @@ -494,6 +521,8 @@ For example: eval $(thefuck --alias --enable-experimental-instant-mode) ``` +##### [Back to Contents](https://github.com/bhav09/thefuck#contents) + ## Developing See [CONTRIBUTING.md](CONTRIBUTING.md) @@ -513,3 +542,5 @@ Project License can be found [here](LICENSE.md). [instant-mode-gif-link]: https://raw.githubusercontent.com/nvbn/thefuck/master/example_instant_mode.gif [homebrew]: https://brew.sh/ [linuxbrew]: https://linuxbrew.sh/ + +##### [Back to Contents](https://github.com/bhav09/thefuck#contents)