Skip to content
This repository was archived by the owner on Aug 21, 2019. It is now read-only.

Commit 5efb976

Browse files
README update
- fixed Readme according to markdown linter, also added console output preview image with controls visualized.
1 parent a9354bf commit 5efb976

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Arduino uc32 Basic UI Shield Simulator
2+
23
The aim of this project is to help students who are learning Arduino, but unfortunately don't have money or are unable to find the hardware to learn on at home. With this simulator students can learn logic required for working with pins, switches, buttons and tasks. Output/Input/Loop are three separate detached tasks using logic which prevents common concurrent problems such as Data Race or Deadlock. This enables real-time response, which makes working with simulator feel like working with the real thing.
34

4-
## Installing
5+
## Installing
6+
57
- [DOWNLOAD](https://github.com/DaniloNovakovic/Arduino_uc32_basic_ui_shield_simulator/archive/master.zip) project from github (you can't copy-paste code from github.com site because it contains special
68
invisible characters that will not allow your program to compile)
79

@@ -11,20 +13,20 @@ invisible characters that will not allow your program to compile)
1113
Character Set -> Use Unicode._). If you forget don't worry, you will get error/warning with adequate message.
1214

1315
- If you get runtime exception upon runing your code, try:
14-
1) Constructing Simulation class with different parameters (default is: `int width = 80, int height = 40, int fontw = 8, int fonth = 10`)
15-
2) Changing your console window size in properties settings. (link how: https://youtu.be/xW8skO7MFYw?t=16m1s (shown around 16. min mark))
16+
1) Constructing Simulation class with different parameters (default is: `int width = 80, int height = 40, int fontw = 8, int fonth = 10`)
17+
2) Changing your console window size in properties settings. (link how: <https://youtu.be/xW8skO7MFYw?t=16m1s> (shown around 16. min mark))
1618

1719
## Usage
18-
- **You write code in _Simulation.cpp_ file**. It is seperated from everything else
19-
so that you can focus only on `setup()` and `loop()` functions, just like when coding in arduino
20-
21-
> Note that i probably won't be making full simulator, i will only be making features required for Embeded Computer Systems class from Applied Software Engineering departement in FTN. Which is basically only L01-L08, SW1-SW4, BTN1-BTN4.
22-
23-
- Controls:
24-
- 1,2,3,4 - SW4, SW3, SW2, SW1 (on/off) (or SW1,SW2,SW3,SW4 (press F1 to swap between these))
25-
- Q,W,E,R - BTN4, BTN3, BTN2, BTN1 (hold to on, release to off)
26-
- LEDs are ordered in descending order from left to right L08,L07,...,L01
2720

21+
**You write code in _Simulation.cpp_ file**. It is seperated from everything else
22+
so that you can focus only on `setup()` and `loop()` functions, just like when coding in arduino
2823

24+
> Note that i probably won't be making full simulator, i will only be making features required for Embeded Computer Systems class from Applied Software Engineering departement in FTN. Which is basically only L01-L08, SW1-SW4, BTN1-BTN4.
2925
26+
Controls:
27+
28+
- 1,2,3,4 - SW4, SW3, SW2, SW1 (on/off) (or SW1,SW2,SW3,SW4 (press F1 to swap between these))
29+
- Q,W,E,R - BTN4, BTN3, BTN2, BTN1 (hold to on, release to off)
30+
- LEDs are ordered in descending order from left to right L08,L07,...,L01
3031

32+
![Console Output Preview](./doc/ArduinoSimulator.JPG)

doc/ArduinoSimulator.JPG

33.8 KB
Loading

0 commit comments

Comments
 (0)