Skip to content

Commit

Permalink
chore: update readme (#6)
Browse files Browse the repository at this point in the history
Update the readme to describe better what this project is. Also adds
several badges.
  • Loading branch information
baszalmstra committed Mar 30, 2024
1 parent 81c1e16 commit b8cf339
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
# Archspec (Rust bindings)
# archspec-rs

Archspec provides standardized human-readable labels for aspects and capabilities of a system with functions to query and compare them.
[![Crates.io][crates-badge]][crates-url]
![License][license-badge]
[![Build Status][build-badge]][build]
[![Project Chat][chat-badge]][chat-url]
[![docs][docs-badge]][docs-url]

The original bindings in Python can be found at https://github.com/archspec/archspec and exposes a similar API but with some constructs adapted to a more ergonomic Rust style.
[license-badge]: https://img.shields.io/crates/l/archspec?style=flat-square
[build-badge]: https://img.shields.io/github/actions/workflow/status/prefix-dev/archspec-rs/rust-compile.yml?style=flat-square&branch=main
[build]: https://github.com/prefix-dev/archspec-rs
[chat-badge]: https://img.shields.io/discord/1082332781146800168.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square
[chat-url]: https://discord.gg/kKV8ZxyzY4
[docs-badge]: https://img.shields.io/badge/docs-main-yellow.svg?style=flat-square
[docs-url]: https://docs.rs/archspec
[crates-badge]: https://img.shields.io/crates/v/archspec.svg?style=flat-square
[crates-url]: https://crates.io/crates/archspec

An implementation of [archspec](https://github.com/archspec/archspec) in Rust.

Archspec aims at providing a standard set of human-understandable labels for various aspects of a system architecture like CPU, network fabrics, etc. and APIs to detect, query and compare them.

The original archspec project grew out of [Spack](https://spack.io/) and is currently under active development.
At present it supports APIs to detect and model compatibility relationships among different CPU microarchitectures.

## License

Expand All @@ -17,4 +36,4 @@ at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.
additional terms or conditions.

0 comments on commit b8cf339

Please sign in to comment.