Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Minor changes to the readme
  • Loading branch information
RedSparr0w authored Dec 12, 2023
1 parent 93a18cf commit a8aa8e5
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,18 @@
# PokéClicker
A game about catching Pokémon, defeating gym leaders, and watching numbers get bigger.

NOTE: PokéClicker is still in development!

You can try out the current state at https://www.pokeclicker.com/

You can reach out on discord to discuss your ideas and how to implement them: https://discord.gg/a6DFe4p

> [!NOTE]
> PokéClicker is still in development!
# Developer instructions

## Rules
## Guidelines
- Make sure the build script is a success. We won't test Pull Requests that fail the building script.
- We won't accept balance Pull Requests, unless it's from a developer or Code Contributor (discord roles).
- We won't accept balance Pull Requests, unless it's from a developer or Code Contributor (Discord roles).
- Pull Requests adding new translatable content should link to a Pull Request in the [translation repo](https://github.com/pokeclicker/pokeclicker-translations) adding your new strings. See the Developer instructions on that repo for more info.
- Split Pull Requests into smaller Pull Requests when possible. It will make it easier for us to review, and easier for you if something's needs to be changed or is rejected.

Expand All @@ -42,8 +43,9 @@ Then finally, run the following command in the command line interface to start a
npm start
```

Changes to the sourcecode will automatically cause the browser to refresh.
This means you don't need to compile TypeScript yourself. Gulp will do this for you :thumbsup:
> [!TIP]
> Changes to the sourcecode will automatically cause the browser to refresh. <br/>
> This means you don't need to compile TypeScript yourself. Gulp will do this for you :thumbsup:

## Use Google cloud shell _(alternative)_
Expand All @@ -52,11 +54,12 @@ This means you don't need to compile TypeScript yourself. Gulp will do this for
npm clean-install
npm start
```
Click the [Web Preview](https://cloud.google.com/shell/docs/using-web-preview) Button and select port `3001` from the displayed menu.
Click the [Web Preview](https://cloud.google.com/shell/docs/using-web-preview) Button and select port `3001` from the displayed menu.<br/>
Cloud Shell opens the preview URL on its proxy service in a new browser window.

## Deploying a new version to Github Pages
Before deploying, check that the game compiles and starts up without errors.
> [!IMPORTANT]
> Before deploying, check that the game compiles and starts up without errors.
Then run the following:
```cmd
Expand Down

0 comments on commit a8aa8e5

Please sign in to comment.