diff --git a/README.md b/README.md index 6c81bc6c4..a8d889377 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Thoth is a multishot system builder. It leverages a visual coding style interface to allows game designers and developers to rapidly create powerful natural language systems and prototype games. -## Setup +## Client Setup 1. Generate a [Personal Access Token](https://github.com/settings/tokens) on Github which will allow you to install private latitude packages. Make sure you check the `write:packages` option. (`read:packages` will suffice as well if you aren't planning on publishing new versions of @latitudegames/thoth-core) 1. In your `~/.bashrc`, append the line `export NPM_TOKEN=YourTokenGoesHere`, and restart your terminal (you can run `source ~/.bashrc` to do so) @@ -11,6 +11,11 @@ Thoth is a multishot system builder. It leverages a visual coding style interfac 1. Run `yarn install` to install project dependencies 1. Run `yarn start` to start the @thoth/client app +## Core Local Setup + +1. Core the contents of `core/.env.example` to `core/.env` +1. Step 2 in Monorepo Development Setup + ## Monorepo Development Within the yarn workspace we need to be mindful of which version of the shared package @latitudegames/thoth-core we are including in our local development setup and our deploys to Netlify.