[WIP] proof of concept

This commit is contained in:
Adrian Lucrèce Céleste 2018-07-16 21:01:29 -04:00
parent d1ed4ce62a
commit 6812e65d84
No known key found for this signature in database
GPG Key ID: DCF1C96EDCB2052B
11 changed files with 113 additions and 0 deletions

16
.vscode/tasks.json vendored Normal file
View File

@ -0,0 +1,16 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "Preview",
"type": "process",
"command": "/home/${env:USER}/.local/bin/mkdocs",
"args": [
"serve"
],
"problemMatcher": []
}
]
}

BIN
assets/images/barrier.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

13
docs/Filing-an-Issue.md Normal file
View File

@ -0,0 +1,13 @@
??? note "We assume you already have a Github account"
If not, [create one](https://github.com/join).
1. Check if somebody hasn't filed the ==same issue already==
- [Currently open issues](https://github.com/debauchee/barrier/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
- [Closed issues](https://github.com/debauchee/barrier/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
2. If Your issue hasn't been filed before (or the fix isn't working), [file one](https://github.com/debauchee/barrier/issues/new)
- When you to to file an an issue, you will see: ![issue_placeholder](https://screenshotscdn.firefoxusercontent.com/images/b8280dcf-52ad-4903-84c4-93fbc23ef2b5.png)
3. Give you issue a title in the field that says `Title`.
4. the `README, DELETE ME` sections will give you instructions on what to do, after following said instructions, please delete these blocks of text.
5. Once done filling out information for your issue, you can use the `Preview` tab to preview what the issue will look like.
6. If you are satisfied with what you have written, press the `Submit new Issue` button.
7. You're done!

0
docs/Initial-Setup.md Normal file
View File

View File

@ -0,0 +1 @@
## Installation

0
docs/Platforms/Linux.md Normal file
View File

View File

0
docs/Platforms/macOS.md Normal file
View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

32
docs/index.md Normal file
View File

@ -0,0 +1,32 @@
# Introduction
Eliminate the barriers between your machines.
## What is Barrier?
Barrier is KVM software forked from [Symless's synergy 1.9 codebase](https://github.com/symless/synergy-core). Synergy was a commercialized reimplementation of the original CosmoSynergy written by Chris Schoeneman.
## What's different?
Whereas synergy has moved beyond its goals from the 1.x era, barrier aims to maintain that simplicity. Barrier will let you use your keyboard and mouse from machine A to control machine B (or more). It's that simple.
## Project goals
Hassle-free reliability. We are users, too. Barrier was created so that we could solve the issues we had with synergy and then share these fixes with other users.
Compatibility. We use more than one operating system and you probably do, too. Windows, macOS, Linux, FreeBSD... Barrier should "just work". We will also have our eye on Wayland when the time comes.
Communication. Everything we do is in the open. Our issue tracker will let you see if others are having the same problem you're having and will allow you to add additional information. You will also be able to see when progress is made and how the issue gets resolved.
## Contact & support
Please be aware that the *only* way to draw our attention to a bug is to file an [issue](https://github.com/debauchee/barrier/issues/new) in the [issue tracker](https://github.com/debauchee/barrier/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) (if one doesn't already exist for your bug). Write a clear, concise, and detailed report and you will get a clear, concise, and detailed response. Priority is always give to issues that affect a wider range of users.
For short and simple questions or to just say hello find us on the Freenode IRC network in the #barrier channel.
!!! info "If your question isn't answered right away"
Don't worry, we're probably busy, sleeping, etc. Do stick around though, your question *will* eventually get answered.
## Contributions
At this time we are looking for developers to help fix the issues found in the [issue tracker](https://github.com/debauchee/barrier/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc). Submit a [pull request](https://github.com/debauchee/barrier/compare) once you've polished up your patch and we'll review and possibly merge it.

51
mkdocs.yml Normal file
View File

@ -0,0 +1,51 @@
# Site information
site_name: Barrier
site_description: Open-source KVM software
site_url: https://debauchee.github.io/barrier
site_author: Adrian Lucrèce Céleste
# Repo info
repo_name: barrier
repo_url: https://github.com/debauchee/barrier
# Copyright
copyright: © 2018 Debauchee Open-Source Group
# Configuration
theme:
name: 'material'
palette:
primary: 'blue'
logo:
icon: 'library_books'
feature:
tabs: true
# Customization
extra:
social:
- type: 'github'
link: 'https://github.com/debauchee'
# Extensions
markdown_extensions:
- admonition
- codehilite
- meta
- footnotes
- toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tilde