Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Created README for V5
  • Loading branch information
junhaoliao authored Dec 19, 2020
1 parent 3726121 commit 797f5fa
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# UG_Remote
**UofT EECG Lab Remote for MacOS / Windows**

Download the latest version here: https://github.com/junhaoliao/UG_Remote/releases

中文读我见下方

## Disclaimer
Your EECG lab remote password, together with your VNC password, will be obfuscated and stored locally. Please understand the risk and do not use it on any public computers. If you have any concerns, please email to [email protected] or [email protected]

You are welcome to visit my personal website: https://junhao.ca

## Instructions (MacOS) - 4 Steps
0. Download UG_Remote5.x.x.dmg from the **Releases** page and double-click to mount.
1. From the mounted disk, drag "UG_Remote.app" into your "Applications" directory.
2. Open the "De-Quarantine" workflow and click the upper-right "Run" button.
3. Open **Launchpad** or **Applications**, you can find the installed "UG_Remote.app". You may drag the app into your dock to create a shortcut.

## Instructions (Windows) - 1 Step
0. Download and extract UG_Remote_win64.5.x.x.zip from the **Releases** page. Double-click on "UG_Remote.exe".

## V5 Change Log
This script is updated to v5.0.0 on December 19, 2020
1. Now we use Python. Goodbye C++. Period.

## This setup is possible thanks to the following free libraries/tools
1. TigerVNC: https://tigervnc.org/
2. Paramiko: http://www.paramiko.org/
3. PySimpleGUI: https://pysimplegui.readthedocs.io/

## Special Thanks to...
Richard Shen from Uoft Architect helped make the icon with Adobe Illustrator for this project.


# 中文 读我
前往Release页面获取最新版本:https://github.com/junhaoliao/UG_Remote/releases

## 声明
你的EECG和VNC密码将在混淆后本地存储。请明晰风险并不要在公共电脑上使用。如有疑问欢迎来邮[email protected][email protected]

欢迎来我的个人网站逛逛:https://junhao.ca

## 使用说明 (MacOS) - 4 步
0.**Releases**页面下载UG_Remote5.x.x.dmg,双击以挂载。
1. 在挂载的镜像里,拖动"UG_Remote.app"到你的"Applications"/"应用程序" 目录
2. 打开"De-Quarantine",点击右上角的"Run"/"运行"按钮
3. 打开**Launchpad****Applications**即可看见安装好的"UG_Remote.app"。你可以拖动应用到**Dock**/****上以创建快捷方式。

## 使用说明 (Windows) - 1 步
0.**Releases**页面下载并解压UG_Remote_win64.5.x.x.zip。双击"UG_Remote.exe"。

## V5 版本说明
本脚本于2020年12月19日更新v5.0.0。
1. 再见,C++。你好呀,Python。

## 在此感谢以下开源软件/库开发者
1. TigerVNC: https://tigervnc.org/
2. Paramiko: http://www.paramiko.org/
3. PySimpleGUI: https://pysimplegui.readthedocs.io/

## 特别感谢
Richard Shen:多伦多大学建筑系,使用Adobe Illustrator制作了本脚本的图标。

0 comments on commit 797f5fa

Please sign in to comment.