Skip to content

Commit

Permalink
docs(README): add ToC.
Browse files Browse the repository at this point in the history
  • Loading branch information
shahinism committed Aug 22, 2024
1 parent 7faa04b commit e882bef
Showing 1 changed file with 28 additions and 13 deletions.
41 changes: 28 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**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)

<!-- markdown-toc end -->


## In Action

[![asciicast](https://asciinema.org/a/Mp4w76BgrVcu4hvUR9nbb8EIL.svg)](https://asciinema.org/a/Mp4w76BgrVcu4hvUR9nbb8EIL)
Expand Down Expand Up @@ -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*:

Expand Down

0 comments on commit e882bef

Please sign in to comment.