Skip to content
This repository has been archived by the owner on Oct 25, 2022. It is now read-only.

Commit

Permalink
doc: Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
oliversalzburg committed Jul 17, 2021
1 parent 56f494a commit da69c13
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,35 @@ The project is set up to be used with [VS Code](https://code.visualstudio.com/).

The development environment is expected to be a POSIX-compliant system. On Windows, WSL will do fine.

Additionally, you will need to have [Docker](https://www.docker.com/get-started) available.
You will need [NodeJS](https://nodejs.org/) and [yarn](https://yarnpkg.com/getting-started/install) to be able to work with the project.

Additionally, you will need to have [Docker](https://www.docker.com/get-started) available, to use the container-based Kitten Game development server. If you do not have Docker, you can still build a release version of the script and drop that into your userscript manager.

### Development

1. Build the development container and start it.
1. Start a watcher to continuously rebuild KS when you make code changes.

```shell
yarn devcontainer:run
yarn userscript:watch
```

The script prints the URL where you can now play the game with KS installed.
> This task can also be started directly in VS Code, using the **Run Task** command.
2. Start a watcher to continuously rebuild KS when you make code changes.
1. Build the development container and start it.

```shell
yarn userscript:watch
yarn devcontainer:run
```

The script prints the URL where you can now play the game with KS installed.

You will need to manually reload the page after each build to get the latest changes in the browser.

### Type-checking

To fill the **Problems** panel in VS Code with all current, type-related errors, run the `typecheck:all` npm task in VS Code.

## Building a release of the userscript
## Building a release version of the userscript

1. Run the script to build the release:

Expand Down

0 comments on commit da69c13

Please sign in to comment.