]> git.sesse.net Git - pistorm/blobdiff - README.md
Merge pull request #4 from beeanyew/rom-mirror-fix
[pistorm] / README.md
index 94a5d308a736a166ef723759fafdfb1824917bd9..0753d3b6851ba7889512f562d9d4e2b27527c97f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,14 @@
 # pistorm
 
+![logo](https://pbs.twimg.com/media/EoFm2H-WEAIxuTE?format=jpg)
+
+
+# Join us on IRC Freenode #PiStorm 
+
+* Hardware files are in Hardware.zip, using the hardware design or parts of it in a commercial product (aka selling with profit) needs a explicit approval from me!
+* Even selling blank PCBs at eBay or so without my approval might makes me pretty mad and probably leads to the forthcomming related projects to be closed source. You have been warned :)
+
+
 Simple quickstart
 
 
@@ -19,7 +28,7 @@ Simple quickstart
 * As soon as the boot process is finished (on the first run it reboots automatically after resizing the filesystems to your SD) you should be greeted
   with the login prompt
 * Log in as user : pi , password : raspberry (The keyboard is set to US Layout on first boot!)
-* run : sudo raspi-config
+* run : `sudo raspi-config`
 * Setup your preferences like keyboard layout,language etc.
 * Setup your Wifi credentials
 * Enable SSH at boot time
@@ -27,27 +36,38 @@ Simple quickstart
   
   You can now reach the pistorm over SSH , look into you router webpage to find the IP of the pistorm or run : ifconfig 
 
-* run : sudo apt-get install git
+* run : `sudo apt-get install git`
 
-* run : git clone https://github.com/captain-amygdala/pistorm.git
+* run : `git clone https://github.com/captain-amygdala/pistorm.git`
 
-* run : cd pistorm
+* run : `cd pistorm`
 
-* run : make
+* run : `make`
 
 
 to start the pistorm emulator 
 
-run : ./run.sh 
+run : `./run.sh`
 
 to exit emulation
-ctrl+c
+`ctrl+c`
 
 If you want to use the minimal hdd image you need to unpack it :
-run : tar xvfz hd0.tar.gz 
+run : `tar xvfz hd0.tar.gz`
 
 **Currently the emulation is a bit buggy on IDE Interrupts, so it takes ages to boot from the emulated HDD. This will be fixed soon :) 
 
+** FPGA bitstream update :
+
+install openocd 
+`sudo apt-get install openocd`
+
+make nprog.sh executable
+`chmod +x nprog.sh`
+
+run the FPGA update with
+`sudo ./nprog.sh`
+