From 9c695ba66a0bfbe6c19e11b39323a8d32264957d Mon Sep 17 00:00:00 2001 From: "Reza (Shahin) Khanipour" Date: Fri, 26 Jul 2024 14:47:59 +0200 Subject: [PATCH] doc(inception): how to enable direnv. --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b45b160..9dce9df 100644 --- a/README.md +++ b/README.md @@ -63,9 +63,24 @@ To start working with Inception, you need: - [pipx](https://pipx.pypa.io/stable/) or [copier](https://copier.readthedocs.io/) -For smoother operation, we recommend installing -[direnv](https://direnv.net/) as described in [this -documentation](https://devenv.sh/automatic-shell-activation/). +#### 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). + +*Suggested Plguins*: + +1. [emacs-direnv](https://github.com/wbolster/emacs-direnv) +2. [direnv.vim](https://github.com/direnv/direnv.vim) #### Notes for MAC users