https://github.com/reloaded-project/reloaded-templates-rust
[WIP] Common Project Configurations for Developing and Shipping Cross Platform Rust code in The Reloaded Project
https://github.com/reloaded-project/reloaded-templates-rust
Last synced: 12 months ago
JSON representation
[WIP] Common Project Configurations for Developing and Shipping Cross Platform Rust code in The Reloaded Project
- Host: GitHub
- URL: https://github.com/reloaded-project/reloaded-templates-rust
- Owner: Reloaded-Project
- License: mit
- Created: 2023-07-09T23:43:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T18:27:48.000Z (over 1 year ago)
- Last Synced: 2024-09-06T21:53:31.936Z (over 1 year ago)
- Language: PowerShell
- Homepage:
- Size: 497 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
Reloaded Rust Templates
##
This template repository is [Sewer's][sewer56] opinionated [Rust][rust], library and other Reloaded
project generators, which use the [cargo-generate][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][codecov] GitHub Action workflows.
- A choice of an [Apache][apache], [MIT][mit], [LGPLv3][lgplv3] or [GPLv3][gplv3] licenses.
- [`cargo-bench`](https://doc.rust-lang.org/cargo/commands/cargo-bench.html) 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](#project-templates)
- [Getting Started](#getting-started)
- [Thanks](#thanks)
- [License](#license)
## 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](https://reloaded-project.github.io/Reloaded-III/)
mod written in Rust. Coming 2024.
## Getting Started
Install [cargo-generate][cargo-generate] via `cargo install cargo-generate`, and create project from template:
```bash
# 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][cargo-generate-install].
The experience running through the experience should look something like this:
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][rust-template] and [rust-github/template][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.
[apache]: https://www.apache.org/licenses/LICENSE-2.0
[cargo-generate]: https://github.com/cargo-generate/cargo-generate
[cargo-generate-install]: https://github.com/cargo-generate/cargo-generate#installation
[codecov]: https://about.codecov.io/
[lgplv3]: https://www.gnu.org/licenses/lgpl-3.0.en.html#license-text
[gplv3]: https://www.gnu.org/licenses/gpl-3.0.en.html#license-text
[mit]: http://opensource.org/licenses/MIT
[rust]: https://www.rust-lang.org/
[rust-github-template]: https://github.com/rust-github/template
[rust-template]: https://github.com/fission-codes/rust-template
[sewer56]: https://github.com/Sewer56