From 939c42e47d2cbf405f004fd5a0bf973a3aec3050 Mon Sep 17 00:00:00 2001 From: zkldi <20380519+zkldi@users.noreply.github.com> Date: Mon, 19 Aug 2024 13:30:13 +0000 Subject: [PATCH] docs: better README --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5b4e0d398..c955378cd 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,14 @@ You can then check the component-specific guides to see how to run those compone ## Quick Setup For Experienced Programmers -Install VSCode and use the dev container extension. -This is the supported way of working and will ensure you have the correct versions of everything. +- Open `Tachi` in vscode +- Install the `Dev Containers` extension +- Run `Dev Container: Rebuild and Open in Container` +- (It can take a couple minutes to build and bootstrap) +- You should be placed inside a vscode instance called `Tachi (dev-container)` +- Inside there, you'll have a perfectly set up shell with fancy utils and fancy graphics. Use `just start` to start Tachi, use `seeds` to run seeds scripts, etc. + +You should not be doing Tachi dev outside of the container. The container is set up perfectly with the right versions of everything and working ESLint and all that. ### Unsupported stuff