-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |