docs: Included a generic Readme for the root of the documents

This commit is contained in:
sithlord48
2026-02-22 16:30:07 -05:00
committed by Chris Rizzitello
parent dd55247380
commit c2342d5124
2 changed files with 21 additions and 1 deletions

View File

@ -29,8 +29,10 @@ endif()
add_custom_target(docs add_custom_target(docs
SOURCES SOURCES
LICENSE LICENSE
Readme.md
Security.md Security.md
) )
install(FILES Security.md DESTINATION ${CMAKE_INSTALL_DOCDIR}) install(FILES Security.md Readme.md DESTINATION ${CMAKE_INSTALL_DOCDIR})
install(FILES LICENSE DESTINATION ${CMAKE_INSTALL_LICENSE_DIR}) install(FILES LICENSE DESTINATION ${CMAKE_INSTALL_LICENSE_DIR})

18
docs/Readme.md Normal file
View File

@ -0,0 +1,18 @@
# Deskflow
Deskflow is a free and open source keyboard and mouse sharing app. Use the keyboard, mouse, or trackpad of one computer to control nearby computers, and work seamlessly between them.
[Homepage](https://deskflow.org) [Code](https://github.com/deskflow/deskflo)
## Getting help online
- View the [wiki](https://github.com/deskflow/deskflow/wiki) Online resource
### Chat with us
- Main discussion on Matrix: [`#deskflow:matrix.org`](https://matrix.to/#/#deskflow:matrix.org) ([Matrix clients](https://matrix.org/ecosystem/clients/))
- Discussion also happens on IRC: `#deskflow` or `#deskflow-dev` on [Libera Chat](https://libera.chat/)
- Start a [new discussion](https://github.com/deskflow/deskflow/discussions) on our GitHub project.
## Reporting security issues
Check [Security](Security.md) to find out how to report security issues.