diff --git a/README.md b/README.md index 9f2d165..262f27e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,37 @@ +[![crates.io](https://img.shields.io/crates/d/riscv.svg)](https://crates.io/crates/vexriscv) +[![crates.io](https://img.shields.io/crates/v/riscv.svg)](https://crates.io/crates/vexriscv) +[![Build Status](https://travis-ci.org/rust-embedded/riscv.svg?branch=master)](https://travis-ci.org/xobs/vexriscv) + # `veriscv` > Low level access to parts of the VexRiscv RISC-V processor -THIS PROJECT IS NOW OBSOLETE +This project is derived from [riscv](https://github.com/rust-embedded/riscv), developed and maintained by the [RISC-V team][team]. -You can access vexriscv-specific csrs in the `riscv` crate, under `riscv::registers::vexriscv::*`. +## [Documentation](https://docs.rs/crate/vexriscv) + +## License + +Copyright 2020 Sean "xobs" Cross +Copyright 2019 [RISC-V team][team] + +Permission to use, copy, modify, and/or distribute this software for any purpose +with or without fee is hereby granted, provided that the above copyright notice +and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS +OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER +TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF +THIS SOFTWARE. + +## Code of Conduct + +Contribution to this crate is organized under the terms of the [Rust Code of +Conduct][CoC], the maintainer of this crate, the [RISC-V team][team], promises +to intervene to uphold that code of conduct. + +[CoC]: CODE_OF_CONDUCT.md +[team]: https://github.com/rust-embedded/wg#the-riscv-team