11pynetworktables2js
22==================
33
4- A cross platform library that forwards NetworkTables key/values over a Websocket ,
4+ A cross platform library that forwards NetworkTables key/values over a WebSocket ,
55so that you can easily write a Driver Station Dashboard for your robot in HTML5 +
66JavaScript.
77
88This library does not provide a full dashboard solution, but is intended to
99provide the necessary plumbing for one to create one with only knowledge
10- of HTML/Javascript . Because the communications layer uses NetworkTables, you
10+ of HTML/JavaScript . Because the communications layer uses NetworkTables, you
1111can connect to all FRC languages (C++, Java, LabVIEW, Python).
1212
1313.. note :: NetworkTables is a protocol used for robot communication in the
@@ -26,15 +26,15 @@ Installation
2626Easy install (Windows only)
2727---------------------------
2828
29- 1. Download the latest pynetworktables2js.exe from github at
29+ 1. Download the latest pynetworktables2js.exe from GitHub at
3030 https://github.com/robotpy/pynetworktables2js/releases .
31312. Extract the exe from the zipfile, and copy it to your directory of HTML/JS
3232 files.
33333. Double click the exe to run it!
3434
3535.. note :: By default, it will connect to 127.0.0.1. To connect to a robot,
3636 you will need to pass the exe arguments to tell it where the robot is.
37- Use --help to see the available options.
37+ Use `` --help `` to see the available options.
3838
3939Manual install
4040--------------
@@ -76,11 +76,11 @@ You can just distribute your HTML files, and run a pynetworktables server
7676using the following command from inside the directory::
7777
7878 python -m pynetworktables2js
79-
79+
8080Or on Windows::
8181
8282 py -m pynetworktables2js
83-
83+
8484This will start a pynetworktables2js server using Tornado (which is installed
8585by default) and it will serve the current directory. You can navigate your
8686browser (I recommend Chrome) to http://127.0.0.1:8888 and see your website.
@@ -103,9 +103,9 @@ If you want to try this out with your current robot, you can do::
103103
104104If you are running pynetworktables2js on your driver station laptop, you can
105105receive robot IP information directly from the Driver Station (handy during
106- actual competitions):
106+ actual competitions)::
107107
108- python tornado_server.py --dashboard
108+ python tornado_server.py --dashboard
109109
110110If you navigate your browser (I recommend Chrome) to http://127.0.0.1:8888, all
111111of the current NetworkTables values will be shown as they change.
@@ -120,18 +120,19 @@ dashboard. Just add your custom files to the www directory.
120120Contributing new changes
121121========================
122122
123- pynetworktables2js is intended to be a project that all members of the FIRST
123+ pynetworktables2js is intended to be a project that all members of the ` FIRST `
124124community can quickly and easily contribute to. If you find a bug, or have an
125125idea that you think others can use:
126126
127- 1. `Fork this git repository <https://github.com/robotpy/pynetworktables2js/fork >`_ to your github account
127+ 1. `Fork this git repository <https://github.com/robotpy/pynetworktables2js/fork >`_
128+ to your GitHub account
1281292. Create your feature branch (``git checkout -b my-new-feature ``)
1291303. Commit your changes (``git commit -am 'Add some feature' ``)
1301314. Push to the branch (``git push -u origin my-new-feature ``)
131- 5. Create new Pull Request on github
132+ 5. Create new Pull Request on GitHub
132133
133134One place in particular I would love to see contributions is in adding useful
134- javascript functions/objects that make creating dashboards even easier!
135+ JavaScript functions/objects that make creating dashboards even easier!
135136
136137Authors
137138=======
0 commit comments