Skip to content

Commit a5a3a12

Browse files
committed
BOM update
1 parent ef39b79 commit a5a3a12

File tree

1 file changed

+81
-9
lines changed

1 file changed

+81
-9
lines changed

README.MD

Lines changed: 81 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,84 @@
1-
TeleBall
2-
========
1+
TeleBall - Retro Handheld Game Console
2+
======================================
33

4-
Build your own Arduino based retro handheld game console.
4+
![DeviceInHand](doc/images/intro_breakout.jpg)
55

6-
This repository contains the [Jekyll](http://jekyllrb.com) source code
7-
for TeleBall's project website and documentation:
8-
[http://sy2002.github.io/TeleBall](http://sy2002.github.io/TeleBall)
6+
What is TeleBall?
7+
-----------------
8+
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.
13+
14+
TeleBall is pretty retro and very minimalistic: It features an
15+
8x8 pixel LED matrix display, a paddle as game controller and one button.
16+
Therefore, the range of possible games is limited but you will be surprised
17+
how much fun and even zenlike meditation this kind of gameplay can bring you,
18+
particularly when you play Tennis for Two with a friend.
19+
20+
![TennisOnTwoDevices](doc/images/intro_tennis.jpg)
21+
22+
About this GIT Repository
23+
-------------------------
24+
25+
This repository contains everything you need to build your own TeleBall
26+
device:
27+
28+
* CAD .stl and .cmb.gz data for your 3D printer or for any online 3D print
29+
shop to 3D print the TeleBall case
30+
31+
* Eagle PCB layout for any online PCB manufacturer to make the TeleBall PCB
32+
33+
* Part lists and hints how to build the hardware
34+
35+
* Arduino source code to flash the firmware
36+
37+
TeleBall is made using the
38+
[Arduino Nano platform](http://arduino.cc/en/Main/ArduinoBoardNano) on a
39+
custom PCB.
40+
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.
46+
47+
### Folder Structure
48+
49+
cad: CAD data for 3D printing the TeleBall case
50+
Use ".stl" to modify the design or to create a custom output file.
51+
Most online 3D print shops can use the ".cmb.gz" for production.
52+
Made with FreeCad: http://www.freecadweb.org
53+
54+
doc: HTML documentation; use `index.html` in root folder to browse
55+
56+
eagle: Electronic schematic diagram including PCB layout.
57+
The libraries.zip files are only needed, if you want to modify
58+
anything; otherwise you can just send the ".brd" file to any
59+
online PCB manufacturing company to receive a TeleBall PCB.
60+
Made with the freeware version of Eagle: http://www.cadsoftusa.com
61+
62+
src: Arduino source code aka Sketch in the subfolder "TeleBall".
63+
Compile and upload it to your device using Arduino's IDE. You need
64+
to install the libraries from libraries.zip first, before being
65+
able to compile. The "archive" folder contains historic versions.
66+
Made with Arduino: http://arduino.cc/de/Main/Software
67+
68+
The Makers
69+
----------
70+
71+
TeleBall is brought to you by
72+
73+
* [sy2002](http://www.sy2002.de): idea, code and original circurit design
74+
* doubleflash: additional circurit design and board layout
75+
* lamags: body housing/case
76+
77+
TeleBall was designed, built and released as an Open Source / Open Hardware
78+
project during August 2014 and January 2015.
79+
80+
TeleBall is a project of
81+
[MEGA - Museum of Electronic Games & Art](http://www.m-e-g-a.org).
82+
83+
We are looking forward to hearing from you. Email to sy2002 at teleball.org
984

10-
Switch to the [TeleBall Master Repository](https://github.com/sy2002/TeleBall)
11-
to work with the official release package that is including the rendered
12-
HTML version of this documentation.

0 commit comments

Comments
 (0)