Skip to content

Commit

Permalink
added basic project config files and placeholder module
Browse files Browse the repository at this point in the history
  • Loading branch information
wyang5 committed Mar 1, 2024
1 parent a06d2a2 commit e210e25
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
on:
pull_request:
branches:
- main
push:
branches:
- main

env:
RUST_BACKTRACE: 1

jobs:
basic-checks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: cargo check
- run: >
rustup component add rustfmt &&
cargo fmt --all --check
- run: >
rustup component add clippy &&
cargo clippy --all-targets --all-features -- -D warnings
run-tests-with-miri:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: rustup +nightly component add miri
- run: cargo +nightly miri test
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/.idea
/target

Cargo.lock
10 changes: 10 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[package]
name = "aarc"
version = "0.0.1"
edition = "2021"
description = "Atomically updatable variants of Arc and Weak for lock-free concurrency."
homepage = "https://github.com/aarc-rs/aarc"
repository = "https://github.com/aarc-rs/aarc"
license = "MIT"
keywords = ["atomic", "arc", "thread-safe", "sync", "lock-free"]
categories = ["concurrency", "memory-management", "data-structures", "algorithms"]
18 changes: 18 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
pub mod example1 {
/// The quick brown fox jumps over the lazy dog.
/// # Examples:
/// ```
/// assert!(true);
/// ```
pub fn say_hello() {
println!("hello world!");
}
}

#[cfg(test)]
mod tests {
#[test]
fn test1() {
assert_eq!(1, 1);
}
}

0 comments on commit e210e25

Please sign in to comment.