Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
aryanpingle committed Sep 30, 2024
1 parent d870cc1 commit e3887a9
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# [The Tunic Translator Tool](https://aryanpingle.github.io/Runic/)

<p align="center">
<img src="./public/images/banner.jpg" alt="Banner image showing off Runic">
</p>

Tunic is a beautiful video game about a small fox in a big world. It has its own written language, which players will not understand.<br>

However - through the efforts of the community - this language has finally been translated and understood.

This website is my love letter to Tunic, and its awesome community - [The Runic Website](https://aryanpingle.github.io/Runic/), Tunic's ultimate translation tool.

## Development

Clone this repository:

```bash
$ git clone https://github.com/aryanpingle/Runic.git
$ cd Runic
```

Install node packages:

```bash
$ npm ci
```

Use `npm run dev` to transpile the code into JS. The `dist` directory will contain the copied assets, and generated code, including `index.html` - and will watch for changes.

Use `npm run build` to generate the minified, bundled code in `dist/`.

0 comments on commit e3887a9

Please sign in to comment.