From ba5c6ddf4a980aca48e046c8615e219595c77c2b Mon Sep 17 00:00:00 2001 From: Matt Jenkins Date: Fri, 11 Apr 2014 00:06:10 +0100 Subject: [PATCH] Markdowned readme --- README.md | 56 +++++++++++++++++++++++++++---------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 313e931..5b40624 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ as required. Default is: To compile the kernel and build a filesystem image, run: - make + $ make A resulting root filesystem image is in file `sdcard.rd`. A kernel is in file `unix.hex` in your target board subdirectory. @@ -72,7 +72,7 @@ You need to put a filesystem image on a SD card. On Windows, use Win32DiskImager utility (https://launchpad.net/win32-image-writer/+download). On Linux, run: - sudo dd if=sdcard.rd of=/dev/XYZ + $ sudo dd if=sdcard.rd of=/dev/XYZ Here `XYZ` is a device name of SD card, as recognized by Linux (sdb in my case). @@ -83,44 +83,44 @@ Kernel image should be written to PIC32 flash memory. The procedure depends on a board used. Max32 board: - cd sys/pic32/ubw32 - AVRTOOLS=/Applications/Mpide.app/Contents/Resources/Java/hardware/tools - $AVRTOOLS/bin/avrdude -C$AVRTOOLS/etc/avrdude.conf -c stk500v2 -p pic32 \ + $ cd sys/pic32/ubw32 + $ AVRTOOLS=/Applications/Mpide.app/Contents/Resources/Java/hardware/tools + $AVRTOOLS/bin/avrdude -C$AVRTOOLS/etc/avrdude.conf -c stk500v2 -p pic32 \ -P /dev/tty.usbserial-* -b 115200 -v -U flash:w:unix.hex:i - Here you need to change AVRTOOLS path and tty name according to your system. +Here you need to change AVRTOOLS path and tty name according to your system. UBW32 board: - Use a pic32prog utility (http://code.google.com/p/pic32prog/) - and a USB cable to install a kernel: +Use a pic32prog utility (http://code.google.com/p/pic32prog/) +and a USB cable to install a kernel: - pic32prog sys/pic32/ubw32/unix.hex + $ pic32prog sys/pic32/ubw32/unix.hex Maximite: - Use the bootload program for Windows, available for download by link: - http://geoffg.net/Downloads/Maximite/Maximite_Update_V2.7B.zip +Use the bootload program for Windows, available for download by link: +http://geoffg.net/Downloads/Maximite/Maximite_Update_V2.7B.zip Explorer 16 board: - There is an auxiliary PIC18 chip on the Explorer 16 board, which can be - used as a built-in programmer device. You will need a PICkit 2 adapter - to install a needed firmware, as described in article: - http://www.paintyourdragon.com/?p=51 - (section "Hack #2: Lose the PICkit 2, Save $35"). - This should be done only once. +There is an auxiliary PIC18 chip on the Explorer 16 board, which can be +used as a built-in programmer device. You will need a PICkit 2 adapter +to install a needed firmware, as described in article: +http://www.paintyourdragon.com/?p=51 +(section "Hack #2: Lose the PICkit 2, Save $35"). +This should be done only once. - Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) - and a USB cable to install a kernel: +Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) +and a USB cable to install a kernel: - pic32prog sys/pic32/explorer16/unix.hex + $ pic32prog sys/pic32/explorer16/unix.hex PIC32 Starter Kit: - Use PICkit 2 adapter and software to install a boot loader from - file `sys/pic32/starter-kit/boot.hex`. This should be done only once. +Use PICkit 2 adapter and software to install a boot loader from +file `sys/pic32/starter-kit/boot.hex`. This should be done only once. - Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) - and a USB cable to install a kernel: +Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) +and a USB cable to install a kernel: - pic32prog sys/pic32/starter-kit/unix.hex + $ pic32prog sys/pic32/starter-kit/unix.hex Simulator @@ -129,12 +129,12 @@ You can use a MIPS32 simulator to develop a debug a RetroBSD software, without a need for hardware board. By default, a simulator is configured to imitate a Max32 board. To build it: - cd tools/virtualmips - make + $ cd tools/virtualmips + $ make Run it: - ./pic32 + $ ./pic32 Configuration of simulated board is stored in file `pic32_max32.conf`.