diff --git a/docs/README.rst b/docs/README.rst index 0b32abf..bbcc5b1 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,8 +1,34 @@ Software Heritage Filesystem (SwhFS) ==================================== User-space POSIX filesystem to browse the `Software Heritage `_ `archive `_, as if it were locally available. Built using the `FUSE `_ framework. + + +Demo +---- + +A live demo of SwhFS in action is available as a `screencast +`_. + + +Bibliography +------------ + +In addition to accompanying technical documentation, SwhFS is also described in +the following scientific paper. If you use SwhFS for your scientific results, +please acknowledge it by citing the paper as follows: + +.. note:: + + Thibault Allançon, Antoine Pietri, Stefano Zacchiroli. `The Software Heritage + Filesystem (SwhFS): Integrating Source Code Archival with Development + `_. In proceedings of `ICSE 2021 + `_: The 43rd International + Conference on Software Engineering, May 2021, Madrid, Spain. IEEE 2021. + + Links: `preprint `_, `bibtex + `_.