README: the documentation is not in the release at the moment

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
ackandClaude Fable 5.1 committed 2026-10-13 20:41:54 +02:00
1 parent 89b4a41b2a
commit 94a3c1ba0e
1 file changed
+4 -11
+4 -11
View File
@@ -13,16 +13,10 @@ may be used.
## Documentation ## Documentation
* [An introduction](docs/introduction.md): what Kokkoja does and whom it The user documentation (an introduction, Kokkoja in five minutes, a
is for. guest's Kokkoja, a host's Kokkoja, and how Kokkoja works) is being moved
* [Kokkoja in five minutes](docs/quickstart.md): the shortest path to a to a new format and is not in this repository at the moment. It will
shared page, for someone at home in a terminal. return with a later release.
* [A guest's Kokkoja](docs/guest.md): joining a session from an
invitation, and the screen.
* [A host's Kokkoja](docs/host.md): installing the Kokkoja program,
starting a session, inviting guests, driving the session.
* [How Kokkoja works](docs/implementation.md): the parts, the encryption,
the page file, running a server.
## In short ## In short
@@ -48,7 +42,6 @@ Documents directory.
written. written.
* `relay/`: the relay server, Python with the `websockets` library. * `relay/`: the relay server, Python with the `websockets` library.
* `deploy/`: how a Kokkoja server is set up (relay plus web site). * `deploy/`: how a Kokkoja server is set up (relay plus web site).
* `docs/`: the documentation above.
* `tests/`: the tests (`python3 -m unittest discover tests`); the * `tests/`: the tests (`python3 -m unittest discover tests`); the
end-to-end test needs Firefox and geckodriver, and the QR code's test end-to-end test needs Firefox and geckodriver, and the QR code's test
needs Node.js and `pip install -r tests/requirements.txt`. needs Node.js and `pip install -r tests/requirements.txt`.