From 409150ec4f75e78b7790ce7a0da55b2b1f0e03dd Mon Sep 17 00:00:00 2001 From: Nick Bolton Date: Fri, 26 Apr 2019 17:02:45 +0100 Subject: [PATCH] #6485 Copied README.md from v2-dev to master --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..9893fcb7 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Synergy Core + +This is the open source core component of Synergy, a keyboard and mouse sharing tool. + +## Recommended + +Things most people will need. + +* [Download](https://symless.com/synergy/downloads) - Get the compiled version of Synergy 1 or Synergy 2. +* [Contact Support](https://symless.com/contact/customer-support) - Open a support ticket and talk directly to the Synergy team. +* [Help Guides](https://symless.com/synergy-help) - Self-help guides and information for when you don't want to talk to people. +* [Join us on Slack](http://bitly.com/synergy-slack) - Talk to other Synergy users in real time using instant messaging. +* [Symless Forums](https://symless.com/forums/forum/11-synergy/) - Discuss Synergy issues on the Symless Forums. + +## Advanced Users + +Not for the faint hearted. Only use these if you know what you're doing. + +* [Getting Started](https://github.com/symless/synergy-core/wiki/Getting-Started) - How to checkout the code from git and use the right branch. +* [Compiling](https://github.com/symless/synergy-core/wiki/Compiling) - Instructions on how to compile Synergy Core from source. +* [Text Config](https://github.com/symless/synergy-core/wiki/Text-Config) - Write a text config file when running Synergy Core manually. +* [Command Line](https://github.com/symless/synergy-core/wiki/Command-Line) - Go full manual and run Synergy Core from the command line. + +## Awesome Tools + +Here are some of the awesome tools Symless make use of across various projects including Synergy. + +Backtrace