Why This Exists and Example sections

This commit is contained in:
Tony Bark 2025-04-30 06:48:51 -04:00
parent 0b265c7768
commit 13455f0d45

View file

@ -2,6 +2,10 @@
S2PK, or Sims 2 Package Manager, aims to provide a simple cross-platform solution to package management.
💡 Why This Exists
S2PK was created to address the need for a reliable and efficient cross-platform package management system for The Sims 2 on Linux and macOS. Players on these platforms often face challenges in managing mods due to the lack of a unified solution that their Windows counterparts solved a long time ago.
## 🛣️ Project Roadmap
| Phase | Goal | Status |
@ -17,6 +21,16 @@ S2PK, or Sims 2 Package Manager, aims to provide a simple cross-platform solutio
- System.CommandLine for CLI parsing (no external libraries)
- Pure backend logic (no UI planned)
## Example
```shell
s2pkg pack -s ./mods -o output.s2pk
```
```
s2pkg unpack -p ./output.s2pk -d "%USERPROFILE%\Documents\EA Games\The Sims 2\Downloads"
```
## 🗓️ Update Cycle
| Type | Frequency | Notes |