ipbus 0.5.1__tar.gz

ipbus-0.5.1/CMakeLists.txt

@@ -0,0 +1,46 @@
+cmake_minimum_required(VERSION 3.23)
+set(PROJECT_ROOT ${CMAKE_CURRENT_LIST_DIR})
+set(PROJECT_VERSION 0.5.1)
+add_compile_definitions(PROJECT_ROOT_PATH="${PROJECT_ROOT}/")
+
+# Stop the warning for gtest and corrosion in newer cmake versions
+if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+  cmake_policy(SET CMP0135 NEW)
+endif()
+
+project(
+  ipbus
+  VERSION ${PROJECT_VERSION}
+)
+
+# Corrosin
+include(FetchContent)
+FetchContent_Declare(
+    Corrosion
+    GIT_REPOSITORY https://github.com/corrosion-rs/corrosion.git
+    GIT_TAG 1499b14e4906a2890f5cee1547c8848db261753d
+)
+FetchContent_MakeAvailable(Corrosion)
+
+# Google Test
+find_package(GTest)
+if (GTest_FOUND)
+  message("Using system GTest")
+else()
+  message("Fetching GTest")
+  include(FetchContent)
+  FetchContent_Declare(
+    googletest
+    URL https://github.com/google/googletest/archive/063de7e9578f82b369302001269680b4b1553359.zip
+  )
+  set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+  FetchContent_MakeAvailable(googletest)
+endif (GTest_FOUND)
+
+include(GNUInstallDirs)
+include(GenerateExportHeader)
+include(CMakePackageConfigHelpers)
+
+# Add bindings folder
+add_subdirectory(ffi/c)
+add_subdirectory(ffi/cpp)

ipbus-0.5.1/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing
+Hello! Thank you for showing interest in my Rust software! Right now, this
+project is entirely maintained by me (`corigan01`), and it would be really
+nice if others could help it improve too.
+
+Please take a look at the open issues for potential things to work on, or send me
+a message on Mattermost (handle is `gkellam`). I will try to answer any questions
+you might have as quickly as possible! 
+
+
+## Getting Started
+
+If you have never used this library before, I would checkout the docs found in
+the README before getting started. These docs should point to you 'IpbusStream'
+which contains a _mini-tutorial_ on how one might use this library.
+
+If you already know the main structure, let's go through some basics on how those
+ideas could be turned into a merged PR:
+
+1. Use `cargo clippy` to fix any lints that it might appear. These are here to
+help you and others have a more standard and coherent Rust program. Clippy also
+detects many anti-patterns that could contribute to slow or otherwise unsafe
+behavior. **CI will fail** without all clippy lints passing _before_ anything
+else.
+
+2. Make sure you run `cargo fmt` before committing your code. This ensures
+everything meets the default rust style guide, and looks consistent across all
+components. This is a **requirement** for CI to pass.
+
+3. Run `cargo test --workspace` to verify all tests are passing before making
+your PR 'ready'. Please use "WIP: [YOUR PR NAME HERE]" when making a new feature
+that is still in-progress. 
+
+4. Ensure all CI jobs successfully pass and correct any errors. 
+
+Congratulations! You have just fixed a bug or added a new feature that
+is almost ready to merge. Please move on to the next section describing PR
+structure.
+
+
+## Pull Requests
+
+All features or pending work should be tracked in a PR. If the work is ongoing
+(ie not ready to merge), please mark the pull request as "WIP: ". Forgejo will
+automatically suggest you do this in case you happen to forget.
+
+Please try to keep your commits small and _atomic_. This helps when we go
+to merge that git is able to resolve most of the issues itself. If a commit
+contains too many sweeping changes across all files, it is very likely to need
+manual merging.
+
+I prefer to use `pull.rebase false` (_merge commit_) style merges when
+integrating PRs into main. Please try not to use _rebase_ within this project. 
+
+Ideally, the `main` branch should always _work_ (passes all tests and jobs).
+This does not mean that the main branch is a release, but instead more of a
+`beta`/`nightly` that _should_ work but might not yet be _stable_.
+
+
+## License
+
+This crate is licensed under the **GNU General Public License v3**. This means
+all dependencies must be compatible with that license. Please checkout the
+free software foundation's website for more information on what it means to be
+_compatible_ with GPL-v3.
+
+This also means that any and all contributions made to this crate by you is
+also subject to the same _GNU General Public License v3_. It is the author's
+responsibility to uphold their code is their own original work.
+
+_AI/LLM generated code cannot be licensed and therefore cannot be used to
+contribute to this project in any way, please see the next section for more
+details._
+
+
+## AI/LLM Policy
+
+**Human Only**: Usage of AI/LLMs are not permitted to make contributions to this
+crate, either by generating code/documentation/tests or otherwise. You are also
+not permitted to ingest any part of this project into an AI/LLM. Please ask me
+instead for your questions or ideas (I am always happy to help!).