Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TakaRikka committed Jul 23, 2023
1 parent 966841b commit 80af31a
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# tp-decomp-docs
# [TP Decomp Docs](https://zsrtp.link)

A website for information, documentation, and progress of the [Twilight Princess decompilation project](https://github.com/zeldaret/tp).

Created with the help of [BotW decomp website](https://github.com/open-ead/botw-decomp-www).

## Setup

1. Download and install [Node.js](https://nodejs.org)

2. Clone this repo and run `npm install`
```shell
git clone https://github.com/zsrtp/tp-decomp-docs
cd tp-decomp-docs
npm install
```

### Run a development server

```shell
npm run start
```

### Make a production build

```shell
npm run build
```

## Licence

Any source code in this repository is MIT licenced.

Documentation is CC BY-SA 4.0 licenced.

0 comments on commit 80af31a

Please sign in to comment.