Skip to content

Commit

Permalink
Preparing README, repo for bump
Browse files Browse the repository at this point in the history
  • Loading branch information
philcali committed May 5, 2012
1 parent ee970f9 commit 3ca768a
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 17 deletions.
45 changes: 29 additions & 16 deletions README.md
Expand Up @@ -6,34 +6,46 @@ same way one would through applications like RDP or VNC.
## Requirements

- [java][java] >= 1.6
- n8han's [cs][cs] (follow instructions on README)
- CLI users: n8han's [cs][cs] (follow instructions on README)
- Other users: [rvc app][app]

[java]: http://java.com/en/download/index.jsp
[cs]: https://github.com/n8han/conscript#readme
[java]: http://java.com/en/download/index.jsp
[app]: http://philcali.github.com/robot-vision/rvc.jar

## CLI Installation

## Installation
These instructions are for those who would rather install this app for primary
launching from the command-line.

```
> cs philcali/robot-vision
```

Test it out with:
Launch the app with:

```
> rvc -j web
```

Direct your browser to [http://localhost:8080/robot-vision.html][locally]
## Mirrors

Whether you downloaded the thick swing app or the cli version, you can test it
out by directing your browser: [http://localhost:8080/robot-vision.html][locally].

[locally]: http://localhost:8080/robot-vision.html

If the app is running properly, you will be greeted with the endless mirrors of
your desktop! Of course, now it's time for you to connect to the host machine
_remotely_, which is the point of this application.

## Controlling and Viewing

RVC was made with the idea of sharing the desktop. Only one person can control
the desktop, while others watch.
the machine, while others watch (or participate).

- `desktop.html` to control the desktop
- `robot-vision.html` read only view of the desktop
- `desktop.html` to control the machine
- `robot-vision.html` read only view of the machine

If you want to wrap the control scripts around basic auth, then pass in
a username and password via `rvc -u user -p password web`.
Expand Down Expand Up @@ -62,7 +74,7 @@ and inject the needed code using a Chrome Extension.

The extension is available at [robot-chrome][vision-ext].

[vision-ext]: https://github.com/philcali/robot-chrome
[vision-ext]: https://chrome.google.com/webstore/detail/ieabafligicoomhcodhiolhlmljhmifi?utm_source=chrome-ntp-icon

__Note__: Chrome extension integration requires that the `gen` action is run at
least once to generate the 32 character random string for authentication:
Expand Down Expand Up @@ -91,8 +103,9 @@ by a third party.

## Screen recording

RVC allows simplistic screen recording by passing in the following arguments
in the commandline:
RVC allows simplistic screen recording by taking a series of snapshots that one
can later build (automatically or not) into a screencast. ClI users can do so by
passing in the following arguments:

```
> rvc record /temp/path/to/jpgs
Expand All @@ -101,7 +114,7 @@ in the commandline:
__Note__: in `web` mode, the controller will have an option to initiate and stop
a recording remotely. Currently, remote recordings are stored in:
```
{USER-HOME}/.robot_vision/recording_{timestamp}
{USER-HOME}/recording_{timestamp}
```

This program does not build the movie from the images. Instead, you can use
Expand Down Expand Up @@ -132,7 +145,7 @@ for screen capture image manipulation and remote control.

Feel free to use it in your projects.

`libraryDependencies += "com.github.philcali" %% "capture-control" % "0.0.1"`
`libraryDependencies += "com.github.philcali" %% "capture-control" % "0.0.2"`

## Client Library

Expand All @@ -151,14 +164,14 @@ Usage: rvc [OPTIONS] action extras
OPTIONS
-b (0.0.0.0)
--bind-address (0.0.0.0) bind address
--bind-address (0.0.0.0) Web server bind address
-f framerate 10 (per second)
--framerate framerate 10 (per second) If in jpeg camera mode, push image data
at specified framerate
-i 8080
--inet-port 8080 internet port
--inet-port 8080 Web server internet port
-j
--jpeg-camera Serves image data via jpeg camera
Expand All @@ -183,7 +196,7 @@ OPTIONS
--user <none> user to auth
-v <viewer password>
--viewer-password <viewer password> separate password for the 'viewer' user
--viewer-password <viewer password> Separate password for the 'viewer' user
(leave blank for open)
```

Expand Down
23 changes: 23 additions & 0 deletions notes/0.0.2.markdown
@@ -0,0 +1,23 @@
- Better recording handling [#1][1]
- Removed Pesky timeout errors when in jpeg mode [#2][2]
- Page title is now the machine hostname [#3][3]
- Added clipboard setting and retrieval of host machine [231200][231200]
- Added popout interface for quality and scaling remote image [d09140][d09140]
- Added Swing UI [4b3ae9][4b3ae9]
- More js keycodes handled [86355b][86355b]

## Upgrading

CLI users can upgrade using `cs` by running the following command:

```
cs philcali/robot-vision
```

[1]: https://github.com/philcali/robot-vision/issues/1
[2]: https://github.com/philcali/robot-vision/issues/2
[3]: https://github.com/philcali/robot-vision/issues/3
[231200]: https://github.com/philcali/robot-vision/commit/2312007c93b5f51ee1a9a1ce547e6efb8b545828
[86355b]: https://github.com/philcali/robot-vision/commit/86355b3f35b2d3e60319199acea732f2e998b27d
[d09140]: https://github.com/philcali/robot-vision/commit/d091407b2d78e9bb6b651a6f67036f44664d004a
[4b3ae9]: https://github.com/philcali/robot-vision/commit/4b3ae9e7e43a535fe6282af6498c0fcfc347ac65
2 changes: 1 addition & 1 deletion src/main/conscript/rvc/launchconfig
@@ -1,5 +1,5 @@
[app]
version: 0.0.1
version: 0.0.2
org: com.github.philcali
name: capture-app
class: capture.app.Main
Expand Down

0 comments on commit 3ca768a

Please sign in to comment.