Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dutterbutter/zksync-devkit
https://github.com/dutterbutter/zksync-devkit
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dutterbutter/zksync-devkit
- Owner: dutterbutter
- License: mit
- Created: 2023-09-15T05:33:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-02T12:10:51.000Z (about 1 year ago)
- Last Synced: 2024-04-14T10:32:06.470Z (9 months ago)
- Size: 2.73 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zkSync Developer Guide
Welcome to zkSync developer guide! Here you will find examples, usage guides, helpful tips, and a complete overview of zkSync development landscape.
## 🚀 Getting Started
These instructions will help you get a copy of the project up and running on your local machine for development and contribution purposes.
### Clone the Repository
```bash
git clone [email protected]:dutterbutter/zksync-developer-pulse.git
cd zksync-developer-pulse
```## 📝 Contributing
We welcome contributions from the community! Please read through our [Contribution Guidelines](CONTRIBUTING.md) before making a pull request.
### Making Changes
1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes.
4. Submit a pull request with a clear description of your changes.## 📖 Documentation Structure
The documentation is organized as follows:
- `README.md`: Provides an overview of the project and setup instructions.
- `SUMMARY.md`: Contains the table of contents for the GitBook.
- `docs/`: This directory contains all the markdown files for the documentation.### Configurations
The `.gitbook.yaml` file at the root of the repository configures how GitBook processes the documentation. It specifies the root directory for the documentation and the paths to the `README.md` and `SUMMARY.md` files.
```yaml
root: ./docs/structure:
readme: ./home/README.md
summary: SUMMARY.md```
## 🔗 Useful Links
- [Published Documentation](https://your-gitbook-url.gitbook.io/project/)
- [GitBook Editor](https://app.gitbook.com/)
- [Markdown Syntax Guide](https://www.markdownguide.org/extended-syntax/)
- [Gitbook Documentation](https://docs.gitbook.com/)## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.