Skip to content

Commit d47f27a

Browse files
committed
update readme
1 parent 7005c24 commit d47f27a

File tree

2 files changed

+4
-56
lines changed

2 files changed

+4
-56
lines changed

README.md

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ pub trait MyCustomExtension {
146146
### Component Documentation
147147

148148
- 📚 **[Development Guide](docs/development.md)** - Comprehensive development setup
149-
- 🔧 **[Extension Development](docs/extensions.md)** - Creating custom extensions
149+
- 🔧 **[Extension Development](docs/extensions.md)** - Creating custom extensions
150150
- 🏗️ **[Architecture Deep Dive](docs/architecture.md)** - System design and internals
151151
- 📋 **[API Reference](docs/api.md)** - Complete API documentation
152152

@@ -200,46 +200,3 @@ cargo test -p pvq-executor
200200
# Run example programs
201201
make test-guests
202202
```
203-
204-
## 🤝 Contributing
205-
206-
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
207-
208-
### Development Workflow
209-
210-
1. Fork the repository
211-
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
212-
3. Make your changes and add tests
213-
4. Ensure all tests pass (`cargo test --all`)
214-
5. Run formatting (`cargo fmt`) and linting (`cargo clippy`)
215-
6. Commit your changes (`git commit -am 'Add amazing feature'`)
216-
7. Push to the branch (`git push origin feature/amazing-feature`)
217-
8. Open a Pull Request
218-
219-
### Code Style
220-
221-
- Follow Rust standard formatting (`cargo fmt`)
222-
- Ensure clippy passes (`cargo clippy`)
223-
- Add comprehensive tests for new features
224-
- Document public APIs with rustdoc comments
225-
226-
## 📄 License
227-
228-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
229-
230-
## 🙏 Acknowledgments
231-
232-
- [PolkaVM](https://github.com/koute/polkavm) - The underlying virtual machine
233-
- [Substrate](https://substrate.io/) - The blockchain development framework
234-
- [Polkadot](https://polkadot.network/) - The multi-chain protocol
235-
236-
## 🔗 Links
237-
238-
- 🌐 **Homepage**: [https://acala.network](https://acala.network)
239-
- 📖 **Documentation**: [https://docs.pvq.dev](https://docs.pvq.dev)
240-
- 💬 **Discord**: [Join our community](https://discord.gg/acala)
241-
- 🐦 **Twitter**: [@AcalaNetwork](https://twitter.com/AcalaNetwork)
242-
243-
---
244-
245-
**Built with ❤️ by the Acala team**

poc/runtime/README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This PoC runtime showcases how to:
1616

1717
- 🏗️ **Complete Runtime**: Full Substrate runtime with PVQ integration
1818
- 🔌 **Extension Support**: Pre-configured with core PVQ extensions
19-
- 🧪 **Testing Ready**: Optimized for development and testing workflows
19+
- 🧪 **Testing Ready**: Optimized for development and testing workflows
2020
- 📡 **Chopsticks Compatible**: Works with Chopsticks for local development
2121
- ⚙️ **Configurable**: Easy to modify and extend for custom use cases
2222

@@ -163,7 +163,7 @@ pub const EXTENSIONS: &[&str] = &["core", "fungibles", "swap"];
163163
2. **Configure in PVQ setup:**
164164
```rust
165165
use my_pvq_extension::ExtensionMyCustom;
166-
166+
167167
// Add to extensions list
168168
```
169169

@@ -240,15 +240,6 @@ Enable debug logging:
240240
RUST_LOG=debug cargo run -p pvq-test-runner -- --program output/guest-example
241241
```
242242

243-
## Contributing
244-
245-
When modifying the PoC runtime:
246-
247-
1. Maintain compatibility with existing PVQ programs
248-
2. Update tests for any configuration changes
249-
3. Document any new pallets or extensions
250-
4. Test with both Chopsticks and the test runner
251-
252243
## Related Components
253244

254245
- [PVQ Executor](../pvq-executor/) - Core execution engine
@@ -258,4 +249,4 @@ When modifying the PoC runtime:
258249

259250
---
260251

261-
*This PoC runtime demonstrates PVQ integration patterns and serves as a foundation for production implementations.*
252+
*This PoC runtime demonstrates PVQ integration patterns and serves as a foundation for production implementations.*

0 commit comments

Comments
 (0)