Skip to content

Commit d5ae3f4

Browse files
committed
wip documentation and pages
1 parent 230d26f commit d5ae3f4

File tree

16 files changed

+992
-9
lines changed

16 files changed

+992
-9
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_site

README.MD

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
TeleBall - Retro Handheld Game Console
22
======================================
33

4-
![DeviceInHand](doc/intro.jpg)
4+
![DeviceInHand](doc/images/intro_breakout.jpg)
55

66
What is TeleBall?
77
-----------------
88

9-
TeleBall is a handheld game console. It lets you play **BreakOut** in
10-
single-player mode using one device and **Tennis for Two** in multi-player
11-
mode using two devices communicating via radio.
9+
TeleBall is a handheld game console. You cannot buy it. You need to build it
10+
by yourself. It lets you play **BreakOut** in single-player mode using one
11+
device and **Tennis for Two** in multi-player mode using two devices
12+
communicating via radio.
1213

1314
TeleBall is pretty retro and very minimalistic: It features an
1415
8x8 pixel LED matrix display, a paddle as game controller and one button.
1516
Therefore, the range of possible games is limited but you will be surprised
1617
how much fun and even zenlike meditation this kind of gameplay can bring you,
1718
particularly when you play Tennis for Two with a friend.
1819

19-
![TennisOnTwoDevices](doc/tennis.jpg)
20+
![TennisOnTwoDevices](doc/images/intro_tennis.jpg)
2021

2122
About this GIT Repository
2223
-------------------------
@@ -37,17 +38,20 @@ TeleBall is made using the
3738
[Arduino Nano platform](http://arduino.cc/en/Main/ArduinoBoardNano) on a
3839
custom PCB.
3940

40-
Browse TeleBall's project page for a much better documentation, including a
41-
how-to play and how-to build guide and a bill of materials (BOM).
41+
Browse TeleBall's [project page](http://sy2002.github.io/TeleBall)
42+
for a much better documentation, including a how-to play and
43+
how-to build guide and a bill of materials (BOM). The project page
44+
is also available offline using `index.html`in the root folder of
45+
this repository.
4246

43-
###Folder Structure
47+
### Folder Structure
4448

4549
cad: CAD data for 3D printing the TeleBall case
4650
Use ".stl" to modify the design or to create a custom output file.
4751
Most online 3D print shops can use the ".cmb.gz" for production.
4852
Made with FreeCad: http://www.freecadweb.org
4953

50-
doc: HTML documentation; use "index.html" in root folder to browse
54+
doc: HTML documentation; use `index.html` in root folder to browse
5155

5256
eagle: Electronic schematic diagram including PCB layout.
5357
The libraries.zip files are only needed, if you want to modify
@@ -70,6 +74,9 @@ TeleBall is brought to you by
7074
* doubleflash: additional circurit design and board layout
7175
* lamags: body housing/case
7276

77+
TeleBall was designed, built and released as an Open Source / Open Hardware
78+
project during August 2014 and January 2015.
79+
7380
TeleBall is a project of
7481
[MEGA - Museum of Electronic Games & Art](http://www.m-e-g-a.org).
7582

doc/images/arrow-down.png

423 Bytes
Loading

doc/images/arrow-down.svg

Lines changed: 22 additions & 0 deletions
Loading
File renamed without changes.
File renamed without changes.

doc/images/octocat-small.png

570 Bytes
Loading

doc/images/octocat.svg

Lines changed: 30 additions & 0 deletions
Loading

doc/images/play_breakout.jpg

20.9 KB
Loading

doc/images/play_overview.jpg

134 KB
Loading

0 commit comments

Comments
 (0)