docs
This commit is contained in:
parent
d29f225b7c
commit
a7a1e64b9d
2 changed files with 14 additions and 13 deletions
13
README.md
13
README.md
|
@ -7,7 +7,7 @@ You see an armed time bomb but don't know how to disarm it. Your friends found a
|
||||||
These are the instructions for building your own OBUS module with an Arduino Nano v3 and the custom PCB. If
|
These are the instructions for building your own OBUS module with an Arduino Nano v3 and the custom PCB. If
|
||||||
you're using other hardware, you might need to do some things differently.
|
you're using other hardware, you might need to do some things differently.
|
||||||
|
|
||||||
0. Read the "[Getting started guide](docs/GETTING_STARTED.md)" to get a general idea of how OBUS works.
|
0. (Read the "[Getting started guide](docs/GETTING_STARTED.md)" to get a general idea of how OBUS works.)
|
||||||
1. [Install](https://www.arduino.cc/en/Guide/#install-the-arduino-desktop-ide) the Arduino IDE.
|
1. [Install](https://www.arduino.cc/en/Guide/#install-the-arduino-desktop-ide) the Arduino IDE.
|
||||||
2. Clone this repository with Git in a permanent location on your drive.
|
2. Clone this repository with Git in a permanent location on your drive.
|
||||||
3. Symlink the library: `ln -s /ABSOLUTE/PATH/TO/REPO/lib /PATH/TO/Arduino/libraries/obus`
|
3. Symlink the library: `ln -s /ABSOLUTE/PATH/TO/REPO/lib /PATH/TO/Arduino/libraries/obus`
|
||||||
|
@ -37,14 +37,3 @@ There are two roles:
|
||||||
These two roles can communicate with each other. To successfully defuse the bomb, they must
|
These two roles can communicate with each other. To successfully defuse the bomb, they must
|
||||||
communicate efficiently and clearly. If a mistake is made, the team gets a strike.
|
communicate efficiently and clearly. If a mistake is made, the team gets a strike.
|
||||||
If they get too many strikes or the timer runs out, the bomb explodes.
|
If they get too many strikes or the timer runs out, the bomb explodes.
|
||||||
|
|
||||||
### Implementation goals
|
|
||||||
|
|
||||||
- It should be easy to add new modules, both hardware- and software-wise
|
|
||||||
- It should be easy to build your own module and get it working with the rest of the game
|
|
||||||
- Every run of the game should be different
|
|
||||||
- It should be possible for multiple people at the same time to develop a new module
|
|
||||||
|
|
||||||
The idea is to have one bomb controller that keeps track of the timer, the amount of strikes and of whether
|
|
||||||
the bomb has been successfully disarmed, and to have multiple modules that have one or more challenges on them
|
|
||||||
that need to be solved.
|
|
||||||
|
|
|
@ -158,7 +158,19 @@ pre {
|
||||||
<tr id="info-1">
|
<tr id="info-1">
|
||||||
<td class="mod-id">1</td>
|
<td class="mod-id">1</td>
|
||||||
<td class="issuee">redfast00</td>
|
<td class="issuee">redfast00</td>
|
||||||
<td class="mod-nm">Serial number module</td>
|
<td class="mod-nm">Serial number</td>
|
||||||
|
<td class="remark"></td>
|
||||||
|
</tr>
|
||||||
|
<tr id="info-2">
|
||||||
|
<td class="mod-id">2</td>
|
||||||
|
<td class="issuee">redfast00</td>
|
||||||
|
<td class="mod-nm">Indicator</td>
|
||||||
|
<td class="remark"></td>
|
||||||
|
</tr>
|
||||||
|
<tr id="info-3">
|
||||||
|
<td class="mod-id">3</td>
|
||||||
|
<td class="issuee">redfast00</td>
|
||||||
|
<td class="mod-nm">Ports</td>
|
||||||
<td class="remark"></td>
|
<td class="remark"></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="info-255">
|
<tr id="info-255">
|
||||||
|
|
Loading…
Reference in a new issue