From 379a58cd6d5854db31d03c38ddf688adf8c774ed Mon Sep 17 00:00:00 2001 From: WangRunji Date: Wed, 20 Feb 2019 17:38:54 +0800 Subject: [PATCH] update README --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c8a2ae4..1a92049 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ -# SimpleFileSystem +# rcore-fs -[![Build Status](https://travis-ci.org/wangrunji0408/SimpleFileSystem-Rust.svg?branch=master)](https://travis-ci.org/wangrunji0408/SimpleFileSystem-Rust) +[![Build Status](https://travis-ci.org/wangrunji0408/rcore-fs.svg?branch=master)](https://travis-ci.org/wangrunji0408/rcore-fs) -A Rust implementation for SFS in [ucore_os_lab](https://github.com/chyyuu/ucore_os_lab) lab8. +The file system module for [rCore OS](https://github.com/wangrunji0408/RustOS). -This is the file system module of [RustOS](https://github.com/wangrunji0408/RustOS). +## Sub-projects -It can also be used in the origin ucore_os_lab, see [uCore with Rust SFS](https://github.com/wangrunji0408/ucore_os_lab/tree/rust-fs/labcodes_answer/lab8_result). \ No newline at end of file +Core: + +* `rcore-fs`: Interfaces and utilities that can be used in an OS. + * Virtual File System: `FileSystem`, `INode` + * Device and cache layer: `BlockDevice`, `CachedDevice`(TODO) + * Unit tests for VFS + +Specific file systems: + +* `rcore-fs-sfs`: Simple File System from [uCore OS](https://github.com/chyyuu/ucore_os_lab) +* `rcore-fs-sefs`: Simple Encrypt File System +* `rcore-fs-fat32`: (TODO) FAT32 +* `rcore-fs-ramfs`: (TODO) RAM based FS. +* `rcore-fs-devfs`: (TODO) Device driver as files + +Utilities: + +* `rcore-fs-fuse`: FUSE wrapper for VFS. Mount any FS to your Linux / macOS. +* `rcore-fs-ucore`: uCore VFS wrapper for Rust VFS. Use any FS in the origin uCore. See [uCore with Rust SFS](https://github.com/wangrunji0408/ucore_os_lab/tree/rust-fs/labcodes_answer/lab8_result) for example. \ No newline at end of file