Skip to content

Commit 0d4c8a8

Browse files
committed
Update index.md
1 parent 6dab84e commit 0d4c8a8

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

docs/index.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,40 @@
11
# PE-Packer (Educational)
22

3-
PE-Packer is an educational laboratory for learning about the Windows Portable Executable (PE) format, safe unpacking workflows, and defensive ML evaluation. It combines a Rust backend with Python bindings.
3+
PEPacker is an educational laboratory for learning the Windows Portable Executable (PE) format, safe unpacking workflows, and defensive ML evaluation. It combines a Rust backend with Python bindings and enforces strict safety gates.
44

5-
- Safety gates strictly enforced for packing.
6-
- Educational PyPI stub with no functional code.
7-
- Source install supports research and instruction.
5+
- Educational PyPI package is a non‑functional stub (prints guidance and policies).
6+
- Source install enables educational workflows for research and instruction.
87

9-
> See: SECURITY.md· LICENSE-APPENDIX.md
8+
See policies: `SECURITY.md` · `LICENSE-APPENDIX.md`
109

11-
## Safety Model (TL;DR)
10+
## Quick start (PyPI Stub)
1211

13-
- Default: dry-run analysis only.
14-
- Actual packing requires both:
12+
Install and run the educational stub:
13+
14+
```bash
15+
pip install rust-python-pe-packer
16+
pe-packer
17+
```
18+
19+
This prints guidance and links to responsible‑use policies.
20+
21+
## Safety model (TL;DR)
22+
23+
- Default: analysis‑only dry run.
24+
- Actual packing requires BOTH:
1525
- `PE_PACKER_ALLOW_PACKING=1`
1626
- `--force`
1727

18-
## Install (Source)
28+
Without both, commands do not write packed binaries.
29+
30+
## Install from source (for education/research)
1931

2032
```bash
2133
uv sync --group dev --group training
2234
uv run maturin develop --features python
2335
```
2436

25-
## CLI Examples
37+
## CLI examples
2638

2739
```bash
2840
# Dry run (no env/--force)
@@ -31,3 +43,9 @@ pe-packer pack input.exe out.exe
3143
# Actual packing (requires both)
3244
PE_PACKER_ALLOW_PACKING=1 pe-packer pack input.exe out.exe --force
3345
```
46+
47+
## Next steps
48+
49+
- Usage guide: `usage.md`
50+
- Safety & policy: `safety.md`
51+
- Architecture overview: `architecture.md`

0 commit comments

Comments
 (0)