From 8b9c04e63abc68995835c2c2a7742274577da7ec Mon Sep 17 00:00:00 2001 From: Evan Pratten Date: Fri, 9 Dec 2022 10:22:43 -0500 Subject: [PATCH] README contents --- .github/workflows/clippy.yml | 1 + README.md | 15 +++++++++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.github/workflows/clippy.yml b/.github/workflows/clippy.yml index c84e99b..fbb5fbd 100644 --- a/.github/workflows/clippy.yml +++ b/.github/workflows/clippy.yml @@ -6,6 +6,7 @@ jobs: steps: - uses: actions/checkout@v1 - run: rustup component add clippy + - run: sudo apt-get update && sudo apt-get install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev cmake llvm-dev libclang-dev clang -y - uses: actions-rs/clippy-check@v1 with: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index a416b46..ec21f98 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ # Direct raylib bindings for Rust -[![Crates.io](https://img.shields.io/crates/v/raylib-ffi)](https://crates.io/crates/raylib-ffi) -[![Docs.rs](https://docs.rs/raylib-ffi/badge.svg)](https://docs.rs/raylib-ffi) +[![Crates.io](https://img.shields.io/crates/v/raylib-ffi)](https://crates.io/crates/raylib-ffi) +[![Docs.rs](https://docs.rs/raylib-ffi/badge.svg)](https://docs.rs/raylib-ffi) [![Build](https://github.com/Ewpratten/raylib-ffi/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/raylib-ffi/actions/workflows/build.yml) [![Clippy](https://github.com/Ewpratten/raylib-ffi/actions/workflows/clippy.yml/badge.svg)](https://github.com/Ewpratten/raylib-ffi/actions/workflows/clippy.yml) - -repo description +`raylib-ffi` aims to provide a "no frills" direct binding to [raylib](https://www.raylib.com/) for rust developers. Unlike the [`raylib-rs` project](https://github.com/deltaphc/raylib-rs), this library trades high-level abstractions for staying truly up to date with upstream raylib (instead of a whole major version behind). ## Dependencies @@ -14,3 +13,11 @@ Fedora: ```sh dnf install clang-devel alsa-lib-devel mesa-libGL-devel libX11-devel libXrandr-devel libXi-devel libXcursor-devel libXinerama-devel libatomic cmake ``` + +## Verifying your build + +`raylib-ffi` bundles a rust version of the example project from raylib proper. To verify your build of this library worked, run: + +```sh +cargo run --example basic +```