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 889026e
Showing 1 changed file with 38 additions and 23 deletions.
61 changes: 38 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,29 @@ 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.

## In Action
<!-- 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)

## Features
# Features

1. **Opinionated Configuration**: Reduces decision fatigue by
providing fewer, well-chosen options.
Expand All @@ -33,7 +51,7 @@ decision and help us to improve them.
6. **Comprehensive .gitignore**: Includes a well-crafted `.gitignore`
file.

### Detailed Features
## Detailed Features

| Feature | Python | Node.js | Go | Rust |
| ------------------------- | ------ | ------- | --- | ---- |
Expand All @@ -53,29 +71,26 @@ decision and help us to improve them.
| difftastic |||||
| dotenv |||||

## How to Use
# How to Use

### Prerequisites
## Prerequisites

To start working with Inception, you need:

- [Devenv](https://devenv.sh/getting-started/), version 1.0.0 or higher.
- [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 All @@ -90,7 +105,7 @@ entry](https://github.com/DataChefHQ/inception/wiki/How-to-enable-direnv%3F).
> - [Add user to the trusted user list](https://github.com/DataChefHQ/inception/wiki/MacOS:-add-user-to-the-trusted-user-list)
> - [Trusting git directory](https://github.com/DataChefHQ/inception/wiki/Trusting-git-directory)
### Initialize a New Project
## Initialize a New Project

Using pipx:

Expand All @@ -104,22 +119,22 @@ If you have copier installed locally, use:
copier copy --trust gh:DataChefHQ/Inception .
```

## Resources
# Resources

- [Devenv Docs](https://devenv.sh/getting-started/)
- [Nix in 100 Seconds](https://www.youtube.com/watch?v=FJVFXsNzYZQ)

## Contributing
# Contributing

We welcome contributions! Please check out our [contributing
guidelines](CONTRIBUTING.md) to get started.

## License
# License

This project is licensed under the MIT License - see the
[LICENSE](LICENSE) file for details.

## Acknowledgments
# Acknowledgments

- Thanks to the open-source community for their invaluable
contributions to projects which we are building on:
Expand Down

0 comments on commit 889026e

Please sign in to comment.