diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 6e1a9424ff..d59a5f934d 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -29,8 +29,10 @@ endif() add_custom_target(docs SOURCES LICENSE + Readme.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}) diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 0000000000..350aa08596 --- /dev/null +++ b/docs/Readme.md @@ -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.