You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[What is a virtual file system and why should I use it?](#what-is-a-virtual-file-system-and-why-should-i-use-it)
26
-
*[Features](#features)
27
-
*[We use the lastest C# features](#we-use-the-lastest-c-features)
28
-
*[Installation](#installation)
29
-
*[NuGet](#nuget)
30
-
*[Source](#source)
31
-
*[Usage](#usage)
31
+
*[📝 Table of Contents](#-table-of-contents)
32
+
*[📖 Introduction](#-introduction)
33
+
*[🧐 What is a virtual file system and why should I use it?](#-what-is-a-virtual-file-system-and-why-should-i-use-it)
34
+
*[📋 Prerequisites](#-prerequisites)
35
+
*[📌 Features](#-features)
36
+
*[🚀 We use the latest C# features](#-we-use-the-latest-c-features)
37
+
*[📥 Installation](#-installation)
38
+
*[📦 NuGet](#-nuget)
39
+
*[📁 From source](#-from-source)
40
+
*[📚 Use cases](#-use-cases)
32
41
*[Creating a virtual file system, add some files and print the content of the root directory as an ASCII tree](#creating-a-virtual-file-system-add-some-files-and-print-the-content-of-the-root-directory-as-an-ascii-tree)
33
-
*[Documentation](#documentation)
34
-
*[Contributing](#contributing)
35
-
*[License](#license)
36
-
*[Contact](#contact)
37
-
*[Acknowledgements](#acknowledgements)
38
-
*[Changelog](#changelog)
39
-
*[Contributors](#contributors)
42
+
*[📄 Documentation](#-documentation)
43
+
*[🤝 Contributing](#-contributing)
44
+
*[📜 License](#-license)
45
+
*[📬 Contact](#-contact)
46
+
*[🙌 Acknowledgements](#-acknowledgements)
47
+
*[🎉 Change log](#-change-log)
48
+
*[✨ Contributors](#-contributors)
40
49
<!-- TOC -->
41
50
42
-
## Introduction
51
+
## 📖 Introduction
43
52
44
53
When writing applications in .NET, you often need to write or read the contents of a file. .NET provides `System.IO`
45
54
namespace dedicated to this purpose. But how do we deal with the filesystem when testing our code?
46
55
47
56
**Virtual File System** is an attempt to solve this problem. Currently, this library is at an early stage of
48
57
development. If you need additional functionality, I invite you to open an issue to discuss it.
49
58
50
-
### What is a virtual file system and why should I use it?
59
+
### 🧐 What is a virtual file system and why should I use it?
51
60
52
61
A virtual file system is a data structure that represents a file system in memory. It is used to simulate a file system
53
62
on a computer. It is useful for testing purposes, for example, when you want to test a file system without actually
54
63
creating files on the hard drive.
55
64
56
-
## Features
65
+
### 📋 Prerequisites
66
+
67
+
- .NET 6.0
68
+
- A C# IDE (Visual Studio, Rider, etc.)
69
+
- A C# compiler (dotnet CLI, etc.)
70
+
71
+
## 📌 Features
57
72
58
73
-[x] Create a virtual file system
59
74
-[x] Create a virtual file or directory
75
+
-[x] Print the contents of a virtual file system as a tree
60
76
-[ ] ...
61
77
62
-
### We use the lastest C# features
78
+
### 🚀 We use the latest C# features
63
79
64
80
This library targets .NET 7.0 and uses the latest C# features. It is written in C# 11.0 and uses the new `init`
65
81
properties, `record` types, `switch` expressions, `using` declarations, and more.
66
82
67
83
I invite you to read the [C# 11.0 documentation](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-11) to
68
84
learn more about these features.
69
85
70
-
## Installation
86
+
## 📥 Installation
71
87
72
-
### NuGet
88
+
### 📦 NuGet
73
89
74
90
VirtualFileSystem is available on [NuGet](https://www.nuget.org/packages/VirtualFileSystem/).
75
91
@@ -85,7 +101,7 @@ or by adding a package reference to your project file:
0 commit comments