diff --git a/README.md b/README.md index 5e855ce..b20fd69 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Or in any client that reads `mcpServers` JSON (Claude Desktop, editors, …): Fourteen tools cover the full workflow, with scan results kept server-side behind a handle, so a 40 000-hit first scan costs a few tokens instead of your whole context. -Read the [MCP guide](docs/mcp.md) to learn more. +Read the [MCP guide](https://pymemoryeditor.readthedocs.io/en/latest/mcp.html) to learn more. --- @@ -127,16 +127,16 @@ Full documentation lives at **[pymemoryeditor.readthedocs.io](https://pymemoryed A quick map of where to go: - - - - - - - - - - + + + + + + + + + +
Quick StartOpen a process, read, write and run your first scan.
Searching memoryValue scans, ranges, refining results, the Cheat Engine loop.
Pattern scanFind code/data with byte signatures (AOB) and regex.
PointersMulti-level pointer chains and the live RemotePointer.
Pointer scanFind static pointers that survive ASLR.
The GUI appThe bundled Cheat Engine-style scanner.
The MCP serverLet an AI assistant drive the scan/refine loop.
API referenceEvery public class, method and parameter.
Platform notesPermissions and quirks on Windows, Linux and macOS.
TroubleshootingCommon errors and how to fix them.
Quick StartOpen a process, read, write and run your first scan.
Searching memoryValue scans, ranges, refining results, the Cheat Engine loop.
Pattern scanFind code/data with byte signatures (AOB) and regex.
PointersMulti-level pointer chains and the live RemotePointer.
Pointer scanFind static pointers that survive ASLR.
The GUI appThe bundled Cheat Engine-style scanner.
The MCP serverLet an AI assistant drive the scan/refine loop.
API referenceEvery public class, method and parameter.
Platform notesPermissions and quirks on Windows, Linux and macOS.
TroubleshootingCommon errors and how to fix them.
--- @@ -158,7 +158,7 @@ A quick map of where to go: ## 🤝 Contributing Pull requests, bug reports and feature ideas are very welcome. Read -[`CONTRIBUTING.md`](CONTRIBUTING.md) for the development setup, test layout and +[`CONTRIBUTING.md`](https://github.com/JeanExtreme002/PyMemoryEditor/blob/main/CONTRIBUTING.md) for the development setup, test layout and the small set of platform-specific quirks to be aware of. If PyMemoryEditor helped your project, please ⭐ the repo — it's the easiest way to @@ -168,4 +168,4 @@ support the work and to help others discover the library. ## License -Released under the [MIT License](LICENSE) — free for personal and commercial use. +Released under the [MIT License](https://github.com/JeanExtreme002/PyMemoryEditor/blob/main/LICENSE) — free for personal and commercial use.