Skip to content

Commit

Permalink
cleanup readme and cargo toml
Browse files Browse the repository at this point in the history
  • Loading branch information
catornot committed Mar 31, 2024
1 parent 7104e8b commit 92ca70b
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 13 deletions.
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
name = "rrplug"
version = "4.0.0"
authors = ["catornot"]
description = "wrappers and functions for R2Northstar plugins"
repository = "https://github.com/catornot/rrplug"
description = "framework for R2Northstar plugins"
repository = "https://github.com/R2NorthstarTools/rrplug"
license = "Apache-2.0 OR MIT"
keywords = ["plugin", "northstar", "titanfall"]
keywords = ["plugin", "northstar", "titanfall", "wrappers", "framework", "titanfall2", "r2northstar"]
exclude = [".gitignore"]
edition = "2021"
rust-version = "1.77"
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![docs.rs](https://docs.rs/rrplug/badge.svg)](https://docs.rs/rrplug)
[![rrplug-test-build](https://github.com/R2NorthstarTools/rrplug/actions/workflows/rrplug-test-build.yml/badge.svg?branch=master)](https://github.com/R2NorthstarTools/rrplug/actions/workflows/rrplug-test-build.yml)

framework for working with [R2Northstar](https://northstar.tf/)'s plugin system.

this crate provides convenient abstractions with compile time checks while not limiting unsafe access to any parts of plugin sys or the titanfall 2 engine.

## rrplug template
Expand Down Expand Up @@ -32,5 +34,3 @@ rrplug had a major rewrite for each plugins version so versions that a `x` plugi
| `3.*.*` | `v3` |
| `2.*.*` | `v2` |
| `0.1.*` | `v1` |

rrplug 4 release soon
2 changes: 1 addition & 1 deletion rrplug_proc/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "rrplug_proc"
version = "4.0.0"
authors = ["catornot"]
description = "crate for proc macros of rrplug"
repository = "https://github.com/catornot/rrplug"
repository = "https://github.com/R2NorthstarTools/rrplug"
license = "Apache-2.0 OR MIT"
keywords = ["plugin", "northstar", "titanfall", "macro"]
edition = "2021"
Expand Down
21 changes: 14 additions & 7 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
//! rrplug is a safe wrapper around the plugin system in [R2Northstar](https://northstar.tf/)
//! # rrplug
//! framework for working with [R2Northstar](https://northstar.tf/)'s plugin system.
//!
//! rrplug uses compile time or sometimes runtime checks to guarantee safety in abstractions
//! this crate provides convenient abstractions with compile time checks while not limiting unsafe access to any parts of plugin sys or the titanfall 2 engine.
//!
//! ## rrplug template
//!
//! install cargo-generate if you don't have it
//! plugins v4 removed some dependencies on external files so now templates are redundant but a [template](https://github.com/catornot/rrplug-template) still exists
//!
//! ## cross compiling plugins
//!
//! To compile a plugin from a host machine that's not using windows, you need to install the required target.
//!
//! ```bash
//! cargo install cargo-generate
//! rustup target add x86_64-pc-windows-gnu
//! ```
//!
//! Then create a cargo config to always compile your project for windows.
//!
//! ```bash
//! cargo generate -g https://github.com/catornot/rrplug.git
//! mkdir .cargo
//! echo "[build]\ntarget = \"x86_64-pc-windows-gnu\"" > .cargo/config.toml
//! ```
//!
//! a git [template](https://github.com/catornot/rrplug-template) also exists but it may or not be maintained as well
#![deny(
unsafe_op_in_unsafe_fn,
Expand Down

0 comments on commit 92ca70b

Please sign in to comment.