Skip to content

Commit

Permalink
docs: update README (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
SkellyBG authored Dec 12, 2023
1 parent c5d49f9 commit 759941e
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# Hive

hex implementation taken from react-hexgrid
A recreation of the board game Hive!

Done as part of CSESoc's Trainee Program.

## Getting started

To run the project locally:

```sh
git clone https://github.com/csesoc/trainee-7-23t3.git
cd trainee-7-23t3
yarn install
yarn dev
```

To install yarn, follow [this guide](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable).

We use [nvm](https://github.com/nvm-sh/nvm) for node versioning.

## Live Demo

You can check out the live demo of the website at https://trainee-7-23t3.fly.dev

0 comments on commit 759941e

Please sign in to comment.