aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Code_Overview.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2018-12-26 15:41:37 -0500
committerKevin O'Connor <kevin@koconnor.net>2019-01-07 19:33:26 -0500
commit70bbdf93347c814ae39b1cd04d04fd66706a8b7e (patch)
tree4b5139f17c15256c8be843e50602590575a0cde7 /docs/Code_Overview.md
parente70b70fb75bb9b6017df3f5ff2d900b897ad3a8c (diff)
downloadkutter-70bbdf93347c814ae39b1cd04d04fd66706a8b7e.tar.gz
kutter-70bbdf93347c814ae39b1cd04d04fd66706a8b7e.tar.xz
kutter-70bbdf93347c814ae39b1cd04d04fd66706a8b7e.zip
sam3: Rename src/sam3x8e to src/sam3
This is in preparation for merging sam3 and sam4 code into one directory. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Code_Overview.md')
-rw-r--r--docs/Code_Overview.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/docs/Code_Overview.md b/docs/Code_Overview.md
index 3060e0ea..2b5fa621 100644
--- a/docs/Code_Overview.md
+++ b/docs/Code_Overview.md
@@ -5,17 +5,16 @@ Directory Layout
================
The **src/** directory contains the C source for the micro-controller
-code. The **src/avr/** directory contains specific code for Atmel
-ATmega micro-controllers. The **src/sam3x8e/** directory contains code
-specific to the Arduino Due style ARM micro-controllers. The
-**src/pru/** directory contains code specific to the Beaglebone's
-on-board PRU micro-controller. The **src/simulator/** contains code
-stubs that allow the micro-controller to be test compiled on other
-architectures. The **src/generic/** directory contains helper code
-that may be useful across different host architectures. The build
-arranges for includes of "board/somefile.h" to first look in the
-current architecture directory (eg, src/avr/somefile.h) and then in
-the generic directory (eg, src/generic/somefile.h).
+code. The **src/avr/**, **src/sam3/**, **src/samd21/**,
+**src/lpc176x/**, **src/stm32f1/**, **src/pru/**, and **src/linux/**
+directories contain architecture specific micro-controller code. The
+**src/simulator/** contains code stubs that allow the micro-controller
+to be test compiled on other architectures. The **src/generic/**
+directory contains helper code that may be useful across different
+architectures. The build arranges for includes of "board/somefile.h"
+to first look in the current architecture directory (eg,
+src/avr/somefile.h) and then in the generic directory (eg,
+src/generic/somefile.h).
The **klippy/** directory contains the host software. Most of the host
software is written in Python, however the **klippy/chelper/**