From b39226282434055616726556ad413fdd5fef11e4 Mon Sep 17 00:00:00 2001 From: Tait Hoyem Date: Sun, 9 Jan 2022 10:18:33 -0700 Subject: [PATCH] Update readme indsutction to reflect new command --- skel/README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/skel/README.md b/skel/README.md index 6f855e5..5875bac 100644 --- a/skel/README.md +++ b/skel/README.md @@ -4,11 +4,6 @@ Here is how to create a new game. ## Step 1 -Remove the comments next to the text "NOTE: uncomment this to create a new game" in `lamegames/settings.py` -Once logged in, this will allow you to see "Skeleton Game" as an option. - -## Step 2 - Before making any changes, try to understand the structure of `/skel/`. Here is what you need to know in simple terms; check out each individual file for more information on how each component works: @@ -19,7 +14,7 @@ Here is what you need to know in simple terms; check out each individual file fo 3. Models are defined in `skel/models.py`. None are included by default, but check out the [Django documentation](https://docs.djangoproject.com/en/4.0/topics/db/models/) for further information on how these work. 4. The HTML template used for the game is defined in `skel/templates/games/skel.html`. -## Step 3 +## Step 2 Let's create a brand new game, disconnected from our "skel" fake game. For the purposes of this guide `xyz` will be the name of our new game. @@ -30,7 +25,7 @@ To create a new game, run the command `python manage.py newgame xyz` a new game For 2, check the syntax of how other apps/games are added for an idea of how to do so. -## Step 4 +## Step 3 Have fun! Look at django guides as well as examples we have created: @@ -42,16 +37,15 @@ Check how these examples work for more information, and look into how Django, Dj Some games (like rock-paper-scissors) will not need such advanced features as models, but they do require knowledge of channels. Others (like Minesweeper) require little knowledge of channels due to their single-player nature, but do require some more models so a game may be saved for a user when they come back. -## Step 5 +## Step 4 Be creative! I want to see the following games eventually make it into lamegames: -* Malcana, -* (simple) Chess, -* Card games: blackjack, poker and "Uno"-like games. -* Chinese Chess (where the knight moves 2+2 instead of 2+1). -* etc. +* Malcana +* (simple) Chess +* Card games: blackjack, poker and "Uno"-like games +* Chinese Chess (where the knight moves 2+2 instead of 2+1) Make it happen, and be the next contributer!