From 036de2d8d09b8f63bfcfef7af43a81d531dc03fd Mon Sep 17 00:00:00 2001 From: Dave Jansen Date: Mon, 6 Dec 2021 15:27:46 +0900 Subject: [PATCH] Added Quick Start/TL;DR section to the README. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5ef5105..371345d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ A VSCode devcontainer configuration optimized for Stardew Valley mod development The devcontainer has been configured and should fully support Fedora and any other environment that uses selinux. +# Quick Start + +The TL;DR of below: + +- Make sure you have SMAPI for developers installed +- Create a symlink to your Stardew Valley installation directory called `_gamedirref` in the root of your project (`ln -s /path/to/stardew-valley ./_gamedirref`) +- Build and re-open project in dev container +- Build your mod project using the included build script (`ctrl+shift+b` or `cmd+shift+b`) +- Happy coding! :-) + # Prerequisites If you are starting with creating a new mod, you can use the "Use this template" option to create a repository under your own account with the prerequisite files in place. From there you can simply set up your Stardew Valley mod project as you usually would.