Skip to content

Commit 5ea4e88

Browse files
felixheldkarlp
authored andcommittedOct 15, 2013
Clarify HACKING document
use stdint-types, not short types remove info on file stucture of examples, this was removed some time ago, add reference to libopencm3-examples instead.
1 parent a99f4fb commit 5ea4e88

File tree

1 file changed

+2
-12
lines changed

1 file changed

+2
-12
lines changed
 

‎HACKING

+2-12
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,12 @@ Development guidelines
5959
- All subsystem-specific function names should be prefixed with the
6060
subsystem name. For example, gpio_set_mode() or rcc_osc_on().
6161

62-
- Please consistently use the short form types from <cm3/common.h>,
63-
e.g. u8, u16, u32, and so on.
62+
- Please consistently use the stdint types.
6463

6564
- Variables that are used to store register values read from registers or
6665
to be stored in a register should be named reg8, reg16, reg32 etc.
6766

68-
- In the examples directory, the following structure should be used:
69-
70-
- One (or more) subdirectories for the type of microcontroller, e.g.
71-
lm3s, lpc13xx, stm32/f1, stm32/f2, stm32/f4.
72-
73-
- One subdirectory in there for each eval board or piece of hardware, e.g.
74-
stm32-h103, lisa-m, stm32vl-discovery, stm32f4-discovery, etc.
75-
76-
- One subdirectory in there for each example, e.g.
77-
miniblink, button, usart, usb_dfu, etc.
67+
- For examples on using libopencm3 see the libopencm3-examples repository.
7868

7969
Tips and tricks
8070
---------------

0 commit comments

Comments
 (0)
Please sign in to comment.