mirror of
https://github.com/open-goal/jak-project
synced 2026-08-15 12:59:39 -04:00
Update documentation (#1767)
Co-authored-by: doctashay <doctashay@github.com>
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://open-goal.github.io/" rel="nofollow"><img src="https://img.shields.io/badge/Documentation-Here-informational" alt="Documentation Badge" style="max-width:100%;"></a>
|
||||
<a href="https://opengoal.dev/docs/intro" rel="nofollow"><img src="https://img.shields.io/badge/Documentation-Here-informational" alt="Documentation Badge" style="max-width:100%;"></a>
|
||||
<a target="_blank" rel="noopener noreferrer" href="https://github.com/open-goal/jak-project/workflows/Build/badge.svg"><img src="https://github.com/open-goal/jak-project/workflows/Build/badge.svg" alt="Linux and Windows Build" style="max-width:100%;"></a>
|
||||
<a href="https://www.codacy.com/gh/open-goal/jak-project/dashboard?utm_source=github.com&utm_medium=referral&utm_content=open-goal/jak-project&utm_campaign=Badge_Coverage" rel="nofollow"><img src="https://app.codacy.com/project/badge/Coverage/29316d04a1644aa390c33be07289f3f5" alt="Codacy Badge" style="max-width:100%;"></a>
|
||||
<a href="https://www.codacy.com/gh/open-goal/jak-project/dashboard?utm_source=github.com&utm_medium=referral&utm_content=open-goal/jak-project&utm_campaign=Badge_Grade" rel="nofollow"><img src="https://app.codacy.com/project/badge/Grade/29316d04a1644aa390c33be07289f3f5" alt="Codacy Badge" style="max-width:100%;"></a>
|
||||
@@ -11,8 +11,8 @@
|
||||
<a href="https://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt=PRs Welcome></a>
|
||||
</p>
|
||||
|
||||
- [READ FIRST](#read-first)
|
||||
- [How to play the game](#how-to-play-the-game)
|
||||
- [Please read first](#please-read-first)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Project Description](#project-description)
|
||||
- [Current Status](#current-status)
|
||||
- [Methodology](#methodology)
|
||||
@@ -40,21 +40,21 @@
|
||||
- [`goal_src/`](#goal_src)
|
||||
- [`game` runtime](#game-runtime)
|
||||
|
||||
## READ FIRST
|
||||
## Please read first
|
||||
|
||||
The github repositories are for development of the project and tracking active issues. Most of the information you will find here pertains to setting up the project for development purposes and is not relevant to a general user.
|
||||
Our repositories on GitHub are primarily for development of the project and tracking active issues. Most of the information you will find here pertains to setting up the project for development purposes and is not relevant to the end-user.
|
||||
|
||||
There is a discord server where discussion occur https://discord.gg/VZbXMHXzWv
|
||||
For questions or additional information pertaining to the project, we have a Discord for discussion here: https://discord.gg/VZbXMHXzWv
|
||||
|
||||
Additionally you can find further information and answers to **frequently asked questions** on the project's main website https://open-goal.github.io/
|
||||
Additionally, you can find further documentation and answers to **frequently asked questions** on the project's main website: https://opengoal.dev
|
||||
|
||||
### How to play the game
|
||||
**Do not use this decompilation project without providing your own legally purchased copy of the game.**
|
||||
|
||||
To just play the game, follow the steps in this video https://www.youtube.com/watch?v=p8I9NfuZOgE
|
||||
### Quick Start
|
||||
|
||||
We don't save any assets from the game - you must use your own legitimately obtained copy of the game.
|
||||
If you just want to play the game, you can follow the steps in this video: https://www.youtube.com/watch?v=p8I9NfuZOgE
|
||||
|
||||
> Note that this installation method is a temporary stop gap while we work on something more user-friendly.
|
||||
We do not distribute any assets from the game - you must use your own legitimately obtained PS2 copy of the game. We support every retail PAL, NTSC, and NTSC-J build, including Greatest Hits copies.
|
||||
|
||||
## Project Description
|
||||
|
||||
@@ -94,7 +94,7 @@ Our decompiler is designed specifically for processing the output of the origina
|
||||
|
||||
The remainder of this README is catered towards people interested in building the project from source, typically with the intention on contributing as a developer.
|
||||
|
||||
If this does not sound like you and you just want to play the game, refer to the above section [How to play the game](#how-to-play-the-game)
|
||||
If this does not sound like you and you just want to play the game, refer to the above section [Quick Start](#quick-start)
|
||||
|
||||
### Docker
|
||||
|
||||
|
||||
Reference in New Issue
Block a user