From e882befff1d23bfad1c3bc3a2948142f89c18b16 Mon Sep 17 00:00:00 2001 From: "Reza (Shahin) Khanipour" Date: Thu, 22 Aug 2024 10:40:43 +0200 Subject: [PATCH] docs(README): add ToC. --- README.md | 41 ++++++++++++++++++++++++++++------------- 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0f0f80c..0b4e396 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,24 @@ we use mainly in [DataChef](https://datachef.co). However, given the open source nature of this project, feel free to challenge these decision and help us to improve them. + +**Table of Contents** + +- [Inception](#inception) + - [In Action](#in-action) + - [Features](#features) + - [Detailed Features](#detailed-features) + - [How to Use](#how-to-use) + - [Prerequisites](#prerequisites) + - [Initialize a New Project](#initialize-a-new-project) + - [Resources](#resources) + - [Contributing](#contributing) + - [License](#license) + - [Acknowledgments](#acknowledgments) + + + + ## In Action [![asciicast](https://asciinema.org/a/Mp4w76BgrVcu4hvUR9nbb8EIL.svg)](https://asciinema.org/a/Mp4w76BgrVcu4hvUR9nbb8EIL) @@ -63,19 +81,16 @@ To start working with Inception, you need: - [pipx](https://pipx.pypa.io/stable/) or [copier](https://copier.readthedocs.io/) -#### Optional but Suggested - -##### [direnv](https://direnv.net) - -Enabling direnv allows you to: - -1. Use your own shell configuration in `devenv` session. -2. Automatically integrated with your IDE (VSCode and Intellij support - it out of the box, and for Emacs and Vim you can use suggested - plugins below). - -For more information on how to enable it you can refer to [this wiki -entry](https://github.com/DataChefHQ/inception/wiki/How-to-enable-direnv%3F). +> [!TIP] +> Enabling [direnv](https://direnv.net) allows you to: +> +> 1. Use your own shell configuration in `devenv` session. +> 2. Automatically integrated with your IDE (VSCode and Intellij support +> it out of the box, and for Emacs and Vim you can use suggested +> plugins below). +> +> For more information on how to enable it you can refer to [this wiki +> entry](https://github.com/DataChefHQ/inception/wiki/How-to-enable-direnv%3F). *Suggested Plguins*: