PCSX2/archived-pcsx2-net-www
1
0
Fork 0
mirror of https://github.com/PCSX2/pcsx2-net-www.git synced 2026-01-31 01:15:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Some tweaks and additions (#410)

Browse Source
This commit is contained in:
KamFretoZ
2025-05-31 13:11:52 +07:00
committed by GitHub
parent 8d75c4ca43
commit 55d1966036
4 changed files with 26 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/advanced/building.md
View File

@@ -189,7 +189,11 @@ build/bin/pcsx2-qt
### Building on an Intel Mac
Build the dependencies using the CI's build script: `.github/workflows/scripts/macos/build-dependencies.sh deps` (this will build the dependencies into the directory `deps`). If you want to use a package manager, you can look at the install script to see the required dependencies. Note that we patch extra features into `libshaderc`, so you will need to compile that one yourself, as the package manager's version will not work.
Build the dependencies using the CI's build script: `.github/workflows/scripts/macos/build-dependencies.sh deps` (this will build the dependencies into the directory `deps`). If you want to use a package manager, you can look at the install script to see the required dependencies.
:::caution
You will need to have Xcode installed to use our CI's build script.
:::
You can set the environment variable `BUILD_FFMPEG=0` to tell the dependency build script to build all the dependencies except ffmpeg, allowing you to use your homebrew or macports-installed ffmpeg, which probably has more features enabled than the build script's.

21
docs/contributing/contributing.md
View File

@@ -13,6 +13,8 @@ As a first step, please review these links as they'll help you understand how th
- [How to Contribute](#how-to-contribute)
- [Just Starting Out](#just-starting-out)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Commenting Etiquette](#commenting-etiquette)
- [Keeping it real](#keeping-it-real)
- [General Documentation And Coding Strategies](#general-documentation-and-coding-strategies)
## How to Contribute
@@ -31,6 +33,7 @@ However if you do have experience in programming and wanted to contribute code,
- If you're unfamilar with git, check out this [brief introduction to Git](./git.md)
- [How to build PCSX2 for Windows](../advanced/building.md#building-on-windows)
- [How to build PCSX2 for macOS](../advanced/building.md#building-on-macos)
- [How to build PCSX2 for Linux](../advanced/building.md#building-on-linux)
## Pull Request Guidelines
@@ -60,9 +63,23 @@ The following is a list of _general_ style recommendations that will make review
- IMPORTANT - if you are running `clang-format` on unrelated changes (ie. formatting an entire file), please do so in a separate commit.
- If you cannot scope your `clang-format` to just your changes and do not want to format unrelated code. Try your best to stick with the existing formatting already established in the file in question.
## General Documentation And Coding Strategies
## Commenting Etiquette
- [Commenting Etiquette](../troubleshooting/identify.md#commenting-etiquette)
GitHub allows users to comment nearly everywhere. You can comment on issues, on commits, or even on one concrete line of a commit. This is a very powerful tool, but also has a great potential for abuse.
### Keeping it real
The comment system is not a forum, and is generally _**not**_ for idle chat. Many of the devs have comments feeding directly into our inboxes, and a bunch of spam for smileys or statements like "make it faster plz" isn't what we consider a good time. So please be considerate.
There are a few rules an guidelines that we all need to follow in order for this public feedback system to work:
- Comments should be relevant to the commit/issue and should contain _useful information_.
- If you're having general problems with PCSX2, you can use our [Issue tracker](https://github.com/PCSX2/pcsx2/issues), or if you don't really know what revision causes it, our [Public Forum](https://forums.pcsx2.net). This way we can discuss and troubleshoot the issue in depth, in its right place.
- Statements like "please make it faster" or "please fix my game" are not acceptable and will be deleted.
- Phrasing the statement as a question like "Will this make it faster?" or "Will this fix my game?" is not acceptable either, and will also be deleted.
- If we delete your post, there was a good reason for it. Deleting posts without justification would be counter-productive, much the same way that allowing posts with no relevant content would also be counter-productive.
## General Documentation And Coding Strategies
- [Coding style](./formatting.md)
- [More comprehensive style-guide](./advanced_formatting.md)

2
docs/post/general.md
View File

@@ -68,7 +68,7 @@ Go to `Settings > Game Properties`
Portable mode allows you to confine all of PCSX2's related data and configuration into its own folder instead of using the user's Documents folder, essentially making it "Portable".
- To enable portable mode, simply create an empty `portable.ini` file in the root directory of your PCSX2 folder
- To enable portable mode, simply create an empty `portable.txt` or `portable.ini` file in the root directory of your PCSX2 folder
- You can also pass in `-portable` as a launch argument to force PCSX2 to run in portable mode
## Save States

18
docs/troubleshooting/identify.md
View File

@@ -72,20 +72,4 @@ It helps to write down the PCSX2 versions you're testing as you go, and note whe
## Reach out for help
After you've collected all the report materials, consider reaching out in either the respective [Discord](https://www.pcsx2.net/discord) channel, the [public forum](https://forums.pcsx2.net/) or our [issue tracker](https://github.com/PCSX2/pcsx2/issues) for further assistance.
## Commenting Etiquette
GitHub allows users to comment nearly everywhere. You can comment on issues, on commits, or even on one concrete line of a commit. This is a very powerful tool, but also has a great potential for abuse.
### Keeping it real
The comment system is not a forum, and is generally _**not**_ for idle chat. Many of the devs have comments feeding directly into our inboxes, and a bunch of spam for smileys or statements like "make it faster plz" isn't what we consider a good time. So please be considerate.
There are a few rules an guidelines that we all need to follow in order for this public feedback system to work:
- Comments should be relevant to the commit/issue and should contain _useful information_.
- If you're having general problems with PCSX2, you can use our [Issue tracker](https://github.com/PCSX2/pcsx2/issues), or if you don't really know what revision causes it, our [Public Forum](https://forums.pcsx2.net). This way we can discuss and troubleshoot the issue in depth, in its right place.
- Statements like "please make it faster" or "please fix my game" are not acceptable and will be deleted.
- Phrasing the statement as a question like "Will this make it faster?" or "Will this fix my game?" is not acceptable either, and will also be deleted.
- If we delete your post, there was a good reason for it. Deleting posts without justification would be counter-productive, much the same way that allowing posts with no relevant content would also be counter-productive.
After you've collected all the report materials, consider reaching out in either the respective [Discord](https://www.pcsx2.net/discord) channel, the [public forum](https://forums.pcsx2.net/) or our [issue tracker](https://github.com/PCSX2/pcsx2/issues) for further assistance. For more details on how to contribute in general, [See our contributing guide.](../contributing/contributing.md)