Refactoring with documentation

This commit is contained in:
Tw93
2025-08-28 19:35:31 +08:00
parent 6630d1f170
commit f5085c0176
14 changed files with 503 additions and 41 deletions

View File

@@ -36,20 +36,20 @@ git clone https://github.com/tw93/Pake.git
cd Pake
# Install dependencies
npm install
pnpm install
# Start development
npm run dev
pnpm run dev
```
### Testing
```bash
# Run all tests (unit + integration + builder)
npm test
pnpm test
# Build CLI for testing
npm run cli:build
pnpm run cli:build
```
## Continuous Integration
@@ -81,9 +81,11 @@ This file is already in `.gitignore` and should not be committed to the reposito
### Common Build Issues
- **Rust compilation errors**: Run `cargo clean` in `src-tauri/` directory
- **Node dependency issues**: Delete `node_modules` and run `npm install`
- **Node dependency issues**: Delete `node_modules` and run `pnpm install`
- **Permission errors on macOS**: Run `sudo xcode-select --reset`
See the [Advanced Usage Guide](docs/advanced-usage.md) for project structure and customization techniques.
## More
It is a good habit to create a feature request issue to discuss whether the feature is necessary before you implement it. However, it's unnecessary to create an issue to claim that you found a typo or improved the readability of documentation, just create a pull request.