Skip to content

Commit f8a04d0

Browse files
committed
Update README.md
1 parent 212544f commit f8a04d0

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,10 +152,9 @@ string tree = vfs.ToString();
152152

153153
## 📄 Documentation
154154

155-
The documentation is still a work in progress.
155+
**Virtual File System** provides a complete documentation of the library available in the [`./doc/api`](./doc/api) folder.
156156

157-
One goal of **Virtual File System** is to provide a complete documentation of the library on **GitHub Pages**. For now,
158-
you can read the XML documentation generated on build.
157+
The documentation is generated using [Doraku's DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation) tool.
159158

160159
All summaries are written in English. If you want to help us translate the documentation, please open an issue to
161160
discuss it.

0 commit comments

Comments
 (0)