Docs: Add normal readme and rename documentation readme

This commit is contained in:
refractionpcsx2 2022-06-20 09:12:08 +01:00
parent 90ca83bd96
commit 7dc10fbe46
2 changed files with 65 additions and 40 deletions

View File

@ -0,0 +1,49 @@
# Documentation Artifacts
- Source Directory: `/pcsx2/pcsx2/Docs`
- Release Directory: `/pcsx2/bin/Docs`
Docs should be written in the source directory first in an easily editable format. Currently, Markdown is the preferred format due to its simple markup and easy portability. GitHub's built-in preview functions are a huge benefit as well.
Visual Studio Code is a cross platform text editor/development platform that can handle Markdown syntax, plus extensions are available to enable in-editor previewing and PDF generation. However, this is not a requirement since other editors will support Markdown, and worst case GitHub supports editing Markdown files in-browser.
## How to Generate
### Setup
To generate the documentation artifacts into the release directory, you will require the following:
- `pandoc`
- Converts from Markdown to PDF
- `miktex` or something similar that provides `pdflatex`
- this is what generates the PDF file
#### Linux / MacOS
Consult pandoc's official documentation - https://pandoc.org/installing.html
#### Windows
In a PowerShell shell, run the following:
```ps1
> iwr -useb get.scoop.sh | iex
> scoop install pandoc latex
```
If you prefer Chocolatey or using the installer, consult pandoc's official documentation - https://pandoc.org/installing.html
### Usage
Run the following, this assumes you have access to bash, either by virtue of running on linux or through something like `git-bash` on Windows.
```bash
> ./gen-docs.sh
```
> You can override the default output directory like so - `OUT_DIR=<PATH> ./gen-docs.sh`
### Customizing Output
For generating the PDF's this popular template is used and has many features that could be useful https://github.com/Wandmalfarbe/pandoc-latex-template#usage reference it's documentation to take advantage of those if desired.

View File

@ -1,49 +1,25 @@
# Documentation Artifacts
# PCSX2
- Source Directory: `/pcsx2/pcsx2/Docs`
- Release Directory: `/pcsx2/bin/Docs`
PCSX2 is a Playstation 2 emulator for Windows, Linux and Mac. The project has been going since 2001 and still going strong, with contributions from many very clever developers over the years! PCSX2 has compatibility upwards of 95% of the Playstation 2 library being playable.
Docs should be written in the source directory first in an easily editable format. Currently, Markdown is the preferred format due to its simple markup and easy portability. GitHub's built-in preview functions are a huge benefit as well.
## Basic usage
Visual Studio Code is a cross platform text editor/development platform that can handle Markdown syntax, plus extensions are available to enable in-editor previewing and PDF generation. However, this is not a requirement since other editors will support Markdown, and worst case GitHub supports editing Markdown files in-browser.
For information on how to set up the emulator, please see our [basic setup](https://pcsx2.net/guides/basic-setup/) guide.
## How to Generate
## Contributing
Pull requests are welcome and can be submitted at our [GitHub page](https://github.com/PCSX2/pcsx2/)
### Setup
Please make sure to follow our coding style guide and fill out the pull request forms with the appropriate information.
To generate the documentation artifacts into the release directory, you will require the following:
## License
[GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.en.html)
- `pandoc`
- Converts from Markdown to PDF
## Donating to the project
If you wish to donate monetarily to the project you can do so via the [GitHub Sponsors](https://github.com/sponsors/PCSX2). All donations are gratefully received!
- `miktex` or something similar that provides `pdflatex`
- this is what generates the PDF file
## Thanks to the following monthly donators
We thank everybody for their contributions to the project, but we would like to give a special shout out to:
#### Linux / MacOS
Consult pandoc's official documentation - https://pandoc.org/installing.html
#### Windows
In a PowerShell shell, run the following:
```ps1
> iwr -useb get.scoop.sh | iex
> scoop install pandoc latex
```
If you prefer Chocolatey or using the installer, consult pandoc's official documentation - https://pandoc.org/installing.html
### Usage
Run the following, this assumes you have access to bash, either by virtue of running on linux or through something like `git-bash` on Windows.
```bash
> ./gen-docs.sh
```
> You can override the default output directory like so - `OUT_DIR=<PATH> ./gen-docs.sh`
### Customizing Output
For generating the PDF's this popular template is used and has many features that could be useful https://github.com/Wandmalfarbe/pandoc-latex-template#usage reference it's documentation to take advantage of those if desired.
- noigeaR
- xTVaser
- And 1 anonymous donator!