From 922d54ba04c1298c3ca2b8d3bb0b5b940497f21e Mon Sep 17 00:00:00 2001 From: John Britton Date: Wed, 18 Nov 2020 23:20:55 -0500 Subject: [PATCH 1/8] create contributing guidelines --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..67a1226 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +## How to contribute to Teleport + +#### **Did you find a bug?** + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/abyssoft/teleport/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/abyssoft/teleport/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and **reproduction steps** with expected and actual behavior. + +#### **Did you fix a bug?** + +* Open a new GitHub pull request. + +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +#### **Do you intend to add a new feature or change an existing one?** + +* Open a [Draft Pull Request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) early and include a description of your intended changes in the body. From c10554e544bad6e03f064b5b44d564ece3533490 Mon Sep 17 00:00:00 2001 From: John Britton Date: Wed, 18 Nov 2020 23:52:10 -0500 Subject: [PATCH 2/8] create a basic `README.md` --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b937149..5a705e0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# teleport -Virtual KVM for OS X +# Teleport +## A Virtual KVM for macOS + +Use one keyboard and pointing device to control multiple Macs. + +### Key Features + +* __Client__ - Control the keyboard and pointing device of another Mac. +* __Server__ - Allow another Mac to control the system's keyboard and pointing device. +* __Pasteboard Synchronization__ - Copy and paste across Macs. + +### Project status + +Teleport is a legacy project that was once closed source. After the software was discontinued, the original author made the source available to the public and passionate users have been making things work on an ad-hoc basis. + +As of [`v1.2.2`](https://github.com/abyssoft/teleport/releases/tag/v1.2.2) All of the key features are known to work on macOS Big Sur. + +Teleport previously allowed for file drag and drop between Macs, encrypted network traffic, and status information displays. These features likely work right now, but are unsupported and subject to removal if they break. + +Our top priority is to keep the key features working smoothly on the lastest macOS operating system. We are not planning to add any new features, but [contributions are welcome](CONTRIBUTING.md). + +#### Current Maintainer + +__John Britton__ (@johndbritton) +* [GitHub](https://github.com/johndbritton) +* [Twitter](https://twitter.com/johndbritton) + +#### Original Author + +__Julien Robert__ (@abyssoft) +* [GitHub](https://github.com/abyssoft) From 0173e975a6f47b8079d78752e005493e67b69f5b Mon Sep 17 00:00:00 2001 From: John Britton Date: Thu, 19 Nov 2020 00:09:23 -0500 Subject: [PATCH 3/8] add installation instructions to the README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 5a705e0..b934626 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,20 @@ Use one keyboard and pointing device to control multiple Macs. * __Server__ - Allow another Mac to control the system's keyboard and pointing device. * __Pasteboard Synchronization__ - Copy and paste across Macs. +### Installation + +#### Manual + +1. Download the [latest release](https://github.com/abyssoft/teleport/releases/latest). +2. Unzip the archive. +3. Drag `Teleport.app` to `/Applications`. + +#### Homebrew + +```bash +brew cask install abyssoft-teleport +``` + ### Project status Teleport is a legacy project that was once closed source. After the software was discontinued, the original author made the source available to the public and passionate users have been making things work on an ad-hoc basis. From f3b79e999e33b27ccce93748daf9eea469cffb43 Mon Sep 17 00:00:00 2001 From: John Britton Date: Thu, 19 Nov 2020 00:40:53 -0500 Subject: [PATCH 4/8] link CONTRIBUTING.md to issues by label --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67a1226..7c9099a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,3 +15,12 @@ #### **Do you intend to add a new feature or change an existing one?** * Open a [Draft Pull Request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) early and include a description of your intended changes in the body. + + +#### **Just looking to help out?** + +* Take a look through issues labeled [`help-wanted`](https://github.com/abyssoft/teleport/labels/help-wanted) for good places to start. + +* You can also take a look at open issues labeled [`bug`](https://github.com/abyssoft/teleport/labels/bug) or [`feature`](https://github.com/abyssoft/teleport/labels/feature). + +* More documentation is always welcome, send a pull request to the `docs` directory. From 160d1a70628d9dd64597107df044f08f96076389 Mon Sep 17 00:00:00 2001 From: John Britton Date: Thu, 19 Nov 2020 00:41:21 -0500 Subject: [PATCH 5/8] configure issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 27 ++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 27 ++++++++++++++++ 4 files changed, 94 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f59176c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: New issue for Bug Report +about: "If you're sure it's reproducible and not just your machine: submit an issue so we can investigate." +labels: "bug-report" +--- + +# Bug report + + + +## What you were trying to do (and why) + + + +## What happened (include any debug output) + + + +## What you expected to happen + + + +## Step-by-step reproduction instructions + + + +## Environment information + +__Server (Mac with keyboard and pointing device)__ + +* Device: +* macOS version: +* Teleport version: + +__Client (Mac being remotely controlled)__ + +* Device: +* macOS version: +* Teleport version: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a50c6a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: New issue for Feature Suggestion +about: Share your idea or suggestion for a new feature for Teleport. +labels: "feature-request" +--- + +# Feature suggestion + + + +# A detailed description of the proposed feature + + + +# The motivation for the feature + + + +# How the feature would be relevant to at least 90% of Teleport users + + + +# What alternatives to the feature have been considered + + + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..2fd3606 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,27 @@ +--- +name: New issue for Question +about: Ask about how to use, configure, or install Teleport. +labels: "question" +--- + +# Feature suggestion + + + +# A detailed description of the proposed feature + + + +# The motivation for the feature + + + +# How the feature would be relevant to at least 90% of Teleport users + + + +# What alternatives to the feature have been considered + + + + From c682659bfb84531973b0658438f8f33267f1562c Mon Sep 17 00:00:00 2001 From: John Britton Date: Thu, 19 Nov 2020 00:45:50 -0500 Subject: [PATCH 6/8] issue template heading "Feature Request" --- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index a50c6a0..c1ae97a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,10 +1,10 @@ --- -name: New issue for Feature Suggestion +name: New issue for Feature Request about: Share your idea or suggestion for a new feature for Teleport. labels: "feature-request" --- -# Feature suggestion +# Feature request From 5182dc7c50fd795634fa3c15e817dd27ee8a0323 Mon Sep 17 00:00:00 2001 From: John Britton Date: Thu, 19 Nov 2020 00:48:34 -0500 Subject: [PATCH 7/8] question issue template --- .github/ISSUE_TEMPLATE/question.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 2fd3606..a83820f 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -4,24 +4,6 @@ about: Ask about how to use, configure, or install Teleport. labels: "question" --- -# Feature suggestion - - - -# A detailed description of the proposed feature - - - -# The motivation for the feature +# Question - -# How the feature would be relevant to at least 90% of Teleport users - - - -# What alternatives to the feature have been considered - - - - From d17d1977c6b732ef7d78453347822a50d5eae9a9 Mon Sep 17 00:00:00 2001 From: John Britton Date: Thu, 19 Nov 2020 00:52:20 -0500 Subject: [PATCH 8/8] link to docs directory from `CONTRIBUTING.md` --- CONTRIBUTING.md | 2 +- docs/.gitkeep | 0 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 docs/.gitkeep diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c9099a..92a5558 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,4 +23,4 @@ * You can also take a look at open issues labeled [`bug`](https://github.com/abyssoft/teleport/labels/bug) or [`feature`](https://github.com/abyssoft/teleport/labels/feature). -* More documentation is always welcome, send a pull request to the `docs` directory. +* More documentation is always welcome, send a pull request to the [`docs`](docs) directory. diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29