소스 검색

add simple README and LICENSE

Runji Wang 4 년 전
부모
커밋
6c88bcf3ed
2개의 변경된 파일46개의 추가작업 그리고 0개의 파일을 삭제
  1. 21 0
      LICENSE
  2. 25 0
      README.md

+ 21 - 0
LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2020 rCore Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 25 - 0
README.md

@@ -0,0 +1,25 @@
+# VirtIO-drivers-rs
+
+[![CI](https://github.com/rcore-os/virtio-drivers/workflows/CI/badge.svg?branch=master)](https://github.com/rcore-os/virtio-drivers/actions)
+
+VirtIO guest drivers in Rust. For **no_std + no_alloc** environment.
+
+🚧 Working In Progress. We are now moving code from [rCore kernel](https://github.com/rcore-os/rCore/tree/master/kernel/src/drivers) to here.
+
+## Components
+
+| Module | Status                                                       |
+| ------ | ------------------------------------------------------------ |
+| Queue  | ⚠️ Not tested                                                 |
+| Block  | ⚠️ Not tested                                                 |
+| Net    | 🚧 [TODO](https://github.com/rcore-os/rCore/blob/master/kernel/src/drivers/net/virtio_net.rs) |
+| GPU    | 🚧 [TODO](https://github.com/rcore-os/rCore/blob/master/kernel/src/drivers/gpu/virtio_gpu.rs) |
+| Input  | 🚧 [TODO](https://github.com/rcore-os/rCore/blob/master/kernel/src/drivers/input/virtio_input.rs) |
+| ...    | ❌ Not implemented                                            |
+
+## Examples & Tests
+
+* x86_64 (TODO)
+
+* [RISCV](./examples/riscv)
+