]> git.sesse.net Git - pistorm/blobdiff - README.md
Fix PiSCSI device selection bug
[pistorm] / README.md
index 87bd9a75e1909656f953ea0e359d709c9ad963a9..522176cb9bc718da18ce694b1b4cb122ee15eb64 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,24 +36,34 @@ 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 : cd pistorm
+* run : `git clone https://github.com/captain-amygdala/pistorm.git`
 
-run : make
+* run : `cd pistorm`
+
+* run : `make`
 
 
 to start the pistorm emulator 
 
-run : ./run.sh 
+run : `sudo ./emulator`
 
 to exit emulation
-ctrl+c
+`ctrl+c` or pressing `q` on the keyboard connected to the Raspberry Pi.
+
+The IDE emulation can take both hard drive images generated using `makedisk` in the `ide` directory (these have a 1KB header) or headerless RDSK/RDB images created for instance in WinUAE or as empty files. The IDE emulation currently has a quirk that may require you to reduce/increase the size of the image file by 2MB in order for it to work.
+
+** FPGA bitstream update :
+
+install openocd 
+`sudo apt-get install openocd`
 
-If you want to use the minimal hdd image you need to unpack it :
-run : tar xvfz hd0.tar.gz 
+make nprog.sh executable
+`chmod +x nprog.sh`
 
-**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 :) 
+run the FPGA update with
+`sudo ./nprog.sh`