summaryrefslogtreecommitdiffstats
path: root/README-DEVELOPERS.lyx
diff options
context:
space:
mode:
authorMichael Buesch <m@bues.ch>2012-04-06 23:23:11 +0200
committerMichael Buesch <m@bues.ch>2012-04-06 23:23:11 +0200
commitc9b74898f30ba1218e2e683151fb082d3bc35fd5 (patch)
tree308f0bca2ddfa98a86d6b3741dbb63cfd7ce26a4 /README-DEVELOPERS.lyx
parent06de5a43527c12b41eebf2f96f85febaf64668b0 (diff)
downloadtoprammer-c9b74898f30ba1218e2e683151fb082d3bc35fd5.tar.xz
toprammer-c9b74898f30ba1218e2e683151fb082d3bc35fd5.zip
Move chip algorithms to submodule
Signed-off-by: Michael Buesch <m@bues.ch>
Diffstat (limited to 'README-DEVELOPERS.lyx')
-rw-r--r--README-DEVELOPERS.lyx13
1 files changed, 8 insertions, 5 deletions
diff --git a/README-DEVELOPERS.lyx b/README-DEVELOPERS.lyx
index 76f48d6..d322402 100644
--- a/README-DEVELOPERS.lyx
+++ b/README-DEVELOPERS.lyx
@@ -469,12 +469,16 @@ The DUT specific top-half lives in the
\begin_inset Quotes eld
\end_inset
-chip_xxx.py
+libtoprammer/chips
\begin_inset Quotes erd
\end_inset
- files, where xxx is the ID of the DUT.
- This file contains a class derived from the
+ module.
+ The files in that module contain the top-half algorithm implementation.
+ The files are named after the chip ID.
+ Make sure to update the __init__.py of the module when adding algorithm
+ implementations.
+ The top-half files contain a class derived from the
\begin_inset Quotes eld
\end_inset
@@ -491,8 +495,7 @@ Chip
\begin_inset Quotes erd
\end_inset
- class provides some basic helper methods for algorithm implementation.
- It also defines the interface that is to be re-implemented in the derived
+ class defines the interface that is to be re-implemented in the derived
subclass.
This interface consists of the following methods:
\end_layout
bues.ch cgit interface