Skip to content

Commit 87016b2

Browse files
committed
add scripts documentation
1 parent 23c9702 commit 87016b2

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

scripts/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Development Scripts
2+
3+
This directory contains cross-platform development scripts for the Hyperloop H10 project.
4+
5+
## Quick Reference
6+
7+
```bash
8+
# Unix/Linux/macOS
9+
./scripts/dev.sh setup
10+
./scripts/dev.sh all
11+
12+
# Windows PowerShell
13+
.\scripts\dev.ps1 setup
14+
.\scripts\dev.ps1 all
15+
16+
# Windows Command Prompt
17+
scripts\dev.cmd setup
18+
scripts\dev.cmd all
19+
```
20+
21+
## Complete Documentation
22+
23+
📚 **Full documentation has moved to: [docs/development/scripts.md](../docs/development/scripts.md)**
24+
25+
The complete documentation includes:
26+
- Detailed usage instructions for all platforms
27+
- Platform-specific notes and troubleshooting
28+
- Advanced configuration options
29+
- CI/CD integration details
30+
31+
## Available Scripts
32+
33+
- **`dev.sh`** - Unix/Linux/macOS development script
34+
- **`dev.ps1`** - Windows PowerShell script (recommended)
35+
- **`dev.cmd`** - Windows Command Prompt script
36+
- **`dev-unified.sh`** - Universal cross-platform script
37+
38+
## Need Help?
39+
40+
- Check the [full documentation](../docs/development/scripts.md)
41+
- Read the [getting started guide](../docs/guides/getting-started.md)
42+
- View [troubleshooting docs](../docs/troubleshooting/)

0 commit comments

Comments
 (0)