Commit 049eef6e9a5ab2ed50df7a74605eacebb2d1069f
authorJakob Gruber <jakob.gruber@gmail.com>
Mon, 16 Jul 2012 16:47:49 +0000 (18:47 +0200)
committerJakob Gruber <jakob.gruber@gmail.com>
Mon, 16 Jul 2012 17:06:45 +0000 (19:06 +0200)
README.md

index 457790fd466423eb86ac8291125b953f403ad49d..75da0ff044e7c00729f98e2450fcc4d7cebb09b8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 simavr - lean and mean Atmel AVR simulator for linux
 ======
 
-/simavr/ is a new AVR simulator for linux, or any platform that uses avr-gcc. It uses 
+_simavr_ is a new AVR simulator for linux, or any platform that uses avr-gcc. It uses 
 avr-gcc own register definition to simplify creating new targets for supported AVR 
 devices. The core was made to be small and compact, and hackable so allow quick 
 prototyping of an AVR project. The AVR core is now stable for use with parts 
@@ -12,15 +12,15 @@ load multipart HEX files.
 
 Supported IOs
 --------------
-* /eeprom/
-* /watchdog/
-* /IO ports/ (including pin interrupts)
-* /Timers/, 8 &16 (Normal, CTC and Fast PWM, the overflow interrupt too)
-* The /UART/, including tx & rx interrupts (there is a loopback/local echo test mode too)
-* /SPI/, master/slave including the interrupt
-* /i2c/ Master & Slave
-* External /Interrupts/, INT0 and so on.
-* /ADC/
+* _eeprom_
+* _watchdog_
+* _IO ports_ (including pin interrupts)
+* _Timers_, 8 &16 (Normal, CTC and Fast PWM, the overflow interrupt too)
+* The _UART_, including tx & rx interrupts (there is a loopback/local echo test mode too)
+* _SPI_, master/slave including the interrupt
+* _i2c_ Master & Slave
+* External _Interrupts_, INT0 and so on.
+* _ADC_
 * Self-programming (ie bootloaders!)
 
 Emulated Cores (very easy to add new ones!)
@@ -39,21 +39,21 @@ Emulated Cores (very easy to add new ones!)
 
 Extras:
 -------
-* /gdb/ support fully work (gdb server) including some pretty cool “passive modes”.
+* _gdb_ support fully work (gdb server) including some pretty cool “passive modes”.
 * There is also very easy support for “VCD” (Value Change Dump) that can be visualized 
-graphicaly as “waveforms” with tools like /gtkwave/ (see bellow).
+graphicaly as “waveforms” with tools like _gtkwave_ (see bellow).
 * There are a few examples of real life firmwares running on simavr, including OpenGL rendering of the display…
-* There is support /Arduino/, but no integration to the IDE
+* There is support _Arduino_, but no integration to the IDE
 
 *Note:* a mailinglist/google group now exists 
 You can also join *#simavr* on Freenode for a very quiet IRC channel.
 
 VCD Support -- built in logic analyzer 
 -----------
-/simavr/ can output most of it's pins, firmware variables, interrupts and a few other
+_simavr_ can output most of it's pins, firmware variables, interrupts and a few other
 things as signals to be dumped into a file that can be plotted using gtkwave for
 further, precise analysis.
-A firmware can contain instructions for /simavr/ to know what to trace, and the file is
+A firmware can contain instructions for _simavr_ to know what to trace, and the file is
 automatically generated.
 Example:
 
@@ -62,10 +62,10 @@ Example:
        { AVR_MCU_VCD_SYMBOL("UDRE0"), .mask = (1 << UDRE0), .what = (void*)&UCSR0A, }, 
 };`
 
-Will tell /simavr/ to generate a trace everytime the UDR0 register changes and everytime
+Will tell _simavr_ to generate a trace everytime the UDR0 register changes and everytime
 the interrupt is raised (in UCSR0A). The *_MMCU_* tag tells gcc that it needs compiling,
 but it won't be linked in your program, so it takes literally zero bytes, this is a code
-section that is private to /simavr/, it's free!
+section that is private to _simavr_, it's free!
 A program running with these instructions and writing to the serial port will generate
 a file that will display:
 `$ ./simavr/run_avr tests/atmega88_example.axf
@@ -90,16 +90,16 @@ to the AVR cycle.
 
 Example:
 --------
-/simavr/ is really made to be the center for emulating your own AVR projects, not just
+_simavr_ is really made to be the center for emulating your own AVR projects, not just
 a debugger, but also the emulating the peripherals you will use in your firmware, so 
 you can test and develop offline, and now and then try it on the hardware.
 
-You can also use /simavr/ to do test units on your shipping firmware to validate it
+You can also use _simavr_ to do test units on your shipping firmware to validate it
 before you ship a new version, to prevent regressions or mistakes.
 
-/simavr/ has a few 'complete projects/ that demonstrate this, most of them were made
-using real hardware at some point, and the firmware binary is /exactly/ the one that
-ran on the hardware. The key here is to emulate the /parts/ or peripherals that
+_simavr_ has a few 'complete projects/ that demonstrate this, most of them were made
+using real hardware at some point, and the firmware binary is _exactly_ the one that
+ran on the hardware. The key here is to emulate the _parts_ or peripherals that
 are hooked to the AVR. Of course, you don't have to emulate the full hardware, you just
 need to generate the proper stimulus so that the AVR is fooled.