Skip to content

Commit

Permalink
Improving readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Brenttime committed Jan 17, 2018
1 parent 21ba6cc commit 928871a
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 2 deletions.
1 change: 0 additions & 1 deletion arduino.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import time
import numpy as np
import pyqtgraph as pg
import time
import keyboard

def key(event):
Expand Down
52 changes: 51 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,55 @@
<h2>Arduino Oscilloscope Project </h2>
Project to build an Oscilloscope using an Arduino
Guide & Video Coming soon

If you want to change scale in the GUI you need to use the right and left arrow keys:
<ul>
<li>Left Arrow Key - reduce scale</li>
<li>Right Arrow Key - increase scale</li>
</ul>

<h2>Prerequisites</h2>
<ul>
<li>Python 3+</li>
<li>Pip3</li>
<li>Keyboard</li>
<li>Serial</li>
<li>NumPy</li>
<li>PyQt</li>
<li>PyQtGraph</li>
</ul>

<h4>Notes</h4>
Run Command means the command will be run in a windows console or in bash.

<h4>Pip3</h3>
With the latest python3, pip3 should be installed!

<h4>Keyboard</h4>
Run Command:
pip3 install keyboard

<h4>Serial</h4>
Run Command:
pip3 install serial

<h4>NumPy</h4>
(To my knowledge is included in python3)
Run Command:
pip3 install numpy


<h4>PyQt</h4>
Run Command:
pip3 install PyQt5

<h4>PyQtGraph</h4>
Windows: Run .exe from here http://www.pyqtgraph.org/
Debian: Run .deb from here http://www.pyqtgraph.org/
*For other Distros: Other Linux:
Many people have generated packages for non-debian Linux distributions, including Arch, Suse, and Gentoo. Check your distribution repository for pyqtgraph pack

<h2>Gif of Current Build </h2>
http://gph.is/2F87jzq
Update Coming Soon

Previous Version: http://gph.is/2F87jzq

0 comments on commit 928871a

Please sign in to comment.