README: Create README with project details and guidelines

Create README to provide project goals, contributing guidelines, community links, and license information.
This commit is contained in:
Stern
2025-09-01 16:55:18 -04:00
committed by SternXD
parent ed07004103
commit c4d2630ed0
2 changed files with 24 additions and 0 deletions
+3
View File
@@ -1 +1,4 @@
# .github
This is the .github repo where the README for the org is held.
+21
View File
@@ -0,0 +1,21 @@
# πŸ‘‹ Welcome to ARMSX2
ARMSX2 is an fork of [PCSX2](https://github.com/PCSX2/pcsx2), designed to bring PlayStation 2 emulation to **ARM-based devices** such as Android, iOS, macOS (Apple Silicon), Linux ARM64, and Windows on ARM devices.
## πŸ“‚ Main Repositories
- [ARMSX2](https://github.com/ARMSX2/ARMSX2) – Main source code for ARMSX2 (not published yet)
- [armsx2-web](https://github.com/ARMSX2/armsx2-web) – Main website for ARMSX2 (not public yet)
- [armsx2-dependencies](https://github.com/ARMSX2/armsx2-dependencies) – Dependencies to build ARMSX2
## πŸ™Œ Contributing
We welcome contributions! Please:
1. Check the [issues](https://github.com/ARMSX2/ARMSX2/issues) (when we are public)
2. Open pull requests for fixes or improvements (when we are public)
3. Join discussions and share feedback
## πŸ“’ Community
Stay connected:
- ARMSX2 Discord: https://discord.gg/AkJgEgETMn
## βš–οΈ License
ARMSX2 follows the same GPL-3.0 license as [PCSX2](https://github.com/PCSX2/pcsx2). Please respect third-party assets and trademarks.