add readme
This commit is contained in:
parent
285d34c72d
commit
0f71cd050a
21
README.md
Normal file
21
README.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Arduino digicode brutforce interpretor
|
||||
|
||||
## Subject
|
||||
|
||||
## Usage
|
||||
|
||||
1. You can modify the passcode of the digicode by changing the variable ``CODE`` in the file ``src/pin_handler.h``
|
||||
|
||||
*Note that the passcode must end with a '#'*
|
||||
|
||||
2. Run the command ``make prepare``
|
||||
3. Give this repository to your student but make sure not to give the ``src/pin_handler.h`` file or to change the passcode you compiled with
|
||||
4. To test the ``student.ino`` just run ``make run``
|
||||
|
||||
## Warning
|
||||
|
||||
This is a very very basic parser, and so it will not work with a certain number of cases:
|
||||
* if you don't use the variable for the pin numbers
|
||||
* if you write 'digitalWrite()' on several lines
|
||||
* if you move the loop() opening bracket on the next line
|
||||
* ...
|
Loading…
Reference in New Issue
Block a user