diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 0000000..bb0f61d --- /dev/null +++ b/docs/architecture.rst @@ -0,0 +1,4 @@ +Architecture +============ + +*TODO* diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..a222481 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,30 @@ +appvm +===== + +*appvm* is the thin easy-to-use hypervisor-based sandboxing software. + +*appvm* was created for the purpose of decreasing complexity of using +graphical software inside virtual machines, at the same time +maintaining reasonable security and keep *appvm* itself simple and +portable. + +While I'm trying to keep that documentation up-to-date, there may be +some missing information. Use ``appvm --help-long`` for checking all +features. + +If you found anything missed here, please make a pull request or send +patches to patch@dumpstack.io. + +If you need personal support, your company is interested in the +project or you just want to share some thoughts -- feel free to create +a new issue or write to root@dumpstack.io. + +Contents +======== + +:ref:`Keyword Index ` + +.. toctree:: + + architecture.rst + threat-model.rst diff --git a/docs/threat-model.rst b/docs/threat-model.rst new file mode 100644 index 0000000..5581a91 --- /dev/null +++ b/docs/threat-model.rst @@ -0,0 +1,4 @@ +Threat model +======================= + +*TODO*