From 655332304c802c0c9ebf7f83d63d33e853596f32 Mon Sep 17 00:00:00 2001 From: syssecfsu Date: Thu, 6 Jan 2022 20:34:37 -0500 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a2029b3..8b01f34 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,22 @@ window (xterm.js) and create a websocket with the server. On the server side, it serves the basic HTML/JS/CSS files and websockets (by shovling the data between pty and xterm). -It is amazing what you can do with less than 200 lines of go code. +It is amazing what you can do with 200 lines of go code. It is just a simple demo in case some people are interested in how to setup xterm.js with websocket. +To use the program, download/clone the code, and in the web_terminal +directory, run ```go build .```, this will create the binary called +web_terminal. To run it, use ```./web_terminal cmd options_to_cmd```. +If no cmd and options are given, web_terminal will run bash by default. +You can run shells but also single programs, such as htop. + +***known bug*** +On MacOS X, running zsh with web_terminal will produce an extra % +each time. Consider it a ___feautre___, will not fix unless there is a +pull request. + **NOTE**