diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2017-04-27 15:14:11 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2017-04-27 15:59:33 -0400 |
| commit | c1c0b2dd387670b168ed6ac229f512e3cab1820e (patch) | |
| tree | 0624592873110d73d7d2183451a1fd395ad21669 /docs/Code_Overview.md | |
| parent | d7a11119558834595dc527fb8d4d5c494745825c (diff) | |
| download | kutter-c1c0b2dd387670b168ed6ac229f512e3cab1820e.tar.gz kutter-c1c0b2dd387670b168ed6ac229f512e3cab1820e.tar.xz kutter-c1c0b2dd387670b168ed6ac229f512e3cab1820e.zip | |
docs: Avoid using "firmware" in the documentation
The term "firmware" is ambiguous - it could refer to the entire
project (host and micro-controller software) or to just the
micro-controller software. Avoid the term in the documentation.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Code_Overview.md')
| -rw-r--r-- | docs/Code_Overview.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/Code_Overview.md b/docs/Code_Overview.md index abc60403..bfff4021 100644 --- a/docs/Code_Overview.md +++ b/docs/Code_Overview.md @@ -17,7 +17,7 @@ host architectures. The build arranges for includes of src/generic/somefile.h). The **klippy/** directory contains the C and Python source for the -host part of the firmware. +host part of the software. The **lib/** directory contains external 3rd-party library code that is necessary to build some targets. @@ -92,8 +92,8 @@ some functionality in C code. Initial execution starts in **klippy/klippy.py**. This reads the command-line arguments, opens the printer config file, instantiates the main printer objects, and starts the serial connection. The main -execution of gcode commands is in the process_commands() method in -**klippy/gcode.py**. This code translates the gcode commands into +execution of G-code commands is in the process_commands() method in +**klippy/gcode.py**. This code translates the G-code commands into printer object calls, which frequently translate the actions to commands to be executed on the micro-controller (as declared via the DECL_COMMAND macro in the micro-controller code). |