Create update_game.md
parent
51ca5354dc
commit
2b9f791655
@ -0,0 +1,37 @@
|
||||
# How to update your Game
|
||||
|
||||
## New Lean version
|
||||
|
||||
You can update the game to any Lean version by simply editing the `lean-toolchain` in your game repo to contain the
|
||||
new lean version `leanprover/lean4:v4.X.0`.
|
||||
|
||||
Before you continue, make sure there [exists a `v4.X.0`-tag in this repo](https://github.com/leanprover-community/lean4game/tags).
|
||||
|
||||
Then, depending on the setup you use, do one of the following:
|
||||
|
||||
* Dev Container: Rebuild the VSCode Devcontainer.
|
||||
* Local Setup: run `lake update` (followed by `lake exe cache get` if you depend on mathlib.)
|
||||
* Gitpod/Codespaces: Create a fresh one
|
||||
|
||||
This will update `lean4game` and `mathlib` in your project to the new lean version.
|
||||
|
||||
## Newest developing setup
|
||||
|
||||
There are a few files in your game repository which are used for the developing setup
|
||||
(dev container/codespaces/gitpod). If you need to update your're developing setup, for example because it doesn't work
|
||||
anymore, you will need to copy the relevant files from the [GameSkeleton](https://github.com/hhu-adam/GameSkeleton) template into your game repo.
|
||||
|
||||
The relevant files are:
|
||||
|
||||
```
|
||||
lakefile.lean
|
||||
.devcontainer/**
|
||||
.docker/**
|
||||
.gitpod
|
||||
.vscode/**
|
||||
```
|
||||
|
||||
simply copy them from the `GameSkeleton` into your game.
|
||||
|
||||
(Note: You should not need to modify any of these files, with the exception of the `lakefile.lean`,
|
||||
where you need to add any dependencies of your game.)
|
Loading…
Reference in New Issue