Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 3.57 KB

README.MD

File metadata and controls

94 lines (70 loc) · 3.57 KB
Raw
reloaded Logo

Reloaded Rust Templates

License-MIT

This template repository is Sewer's opinionated Rust, library and other Reloaded project generators, which use the cargo-generate tool.

These templates provide various features for getting-up and running with cross platform Rust library or Reloaded3 mod development.

  • Standardized README, Contributing Guidelines & Project Layout.
  • GitHub Issue and Pull Request templates.
  • VSCode Workflow & Integration.
  • Test, lint, audit, and code coverage (via Codecov GitHub Action workflows.
  • A choice of an Apache, MIT, LGPLv3 or GPLv3 licenses.
  • cargo-bench integration (optional).
  • Cross-compilation & testing; including testing for Wine on Linux (optional).
  • Profile Guided Optimization (optional).
  • Native C exports (optional), and C# exports.

Outline

Project Templates

This repository contains two sub-templates:

  • library: for generating a rust library, webserver, or binary/executable project.

  • reloaded3 for generating a Reloaded-III mod written in Rust. Coming 2024.

Getting Started

Install cargo-generate via cargo install cargo-generate, and create project from template:

# This might take a while
cargo install cargo-generate
cargo generate --git https://github.com/Reloaded-Project/reloaded-templates-rust.git

More installation options are available here.

The experience running through the experience should look something like this:

cargo-generate Rust Binary Application Screenshot

Once you generate a template, further instructions might await in your project's README file 😉.

Thanks

These templates are inspired by fission-codes/rust-template and rust-github/template; and their contributors. I'd like to extend my personal token of gratitude.

License

This repository is licensed under the MIT license; however note, most Reloaded components themselves are licensed LGPL or GPLv3.