Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 3.77 KB

README.md

File metadata and controls

71 lines (52 loc) · 3.77 KB
Raw

License GitHub Actions Workflow Status Quality Gate Status Maintenance GitHub pull-requests GitHub Issues GitHub forks GitHub stars

Rustify - A Rust Project Template

Welcome to Rustify! 🦀

Rustify is a template for kickstarting your Rust projects. Whether you're a seasoned Rustacean or just getting started with the language, Rustify provides a solid foundation for building reliable and efficient software in Rust.

Features

  • Cargo Integration: Rustify leverages Cargo, Rust's package manager and build system, to manage dependencies and build your project.
  • Configured for Common Tools: This template comes pre-configured with common tools and configurations such as Gitignore, Cargo.toml, and a basic project structure to save you time.
  • Testing Framework Included: Rustify includes a testing framework setup, so you can start writing tests for your code right away.
  • Documentation Setup: Rustify encourages documentation with a pre-configured setup for Rust's documentation generator, Rustdoc.
  • License: A pre-configured Apache License file is included, allowing you to easily choose an open-source license for your project.

Getting Started

To use Rustify to start a new project, follow these simple steps:

  1. Clone this repository: git clone https://github.com/gvatsal60/rustify.git.
  2. Rename the directory to your project name: mv rustify your-project-name.
  3. Navigate into your project directory: cd your-project-name.
  4. Start coding! 🚀

Note: rustify folder name should be same as the root folder name else change the PROJECT_NAME variable.

Project Structure

rustify/
├── conf
│   └── docker.mk              # Makefile include for Docker configuration
├── dockerfiles
│   └── Dockerfile.alpine      # Dockerfile for building Alpine-based Docker image
├── Makefile                   # Main Makefile for project automation
├── project
│   ├── Cargo.lock             # Dependency lock file generated by Cargo
│   ├── Cargo.toml             # Manifest file for Rust project dependencies
│   ├── src
│   │   └── main.rs            # Main Rust source file
│   └── tests
│       ├── Cargo.toml         # Manifest file for Rust test dependencies
│       └── src
│           └── main.rs        # Main Rust test source file
├── LICENSE                    # License file for the project
└── README.md                  # Project documentation and instructions

Contributing

Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.

Acknowledgements

Rustify is inspired by various Rust project templates and best practices within the Rust community.

Happy coding with Rustify! If you have any questions or need further assistance, don't hesitate to reach out. 🚀🦀