From 000aa189ed898373e218871355460ffce3a7d066 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 15 May 2016 16:58:11 +1000 Subject: [PATCH] README updates --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f4110088..920daca9 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,9 @@ The following default fields are extracted and can be added to the output BoM fi * References - List of part references included in a particular group * Quantity - Number of components included in a particular group * Part - Part name as per the schematic symbol -* Part Lib - Part library for the symbol **(default - not output to BoM file)** +* Part Lib - Part library for the symbol *(default - not output to BoM file)* * Footprint - Part footprint -* Footprint Lib - Part footprint library **(default - not output to BoM file)** +* Footprint Lib - Part footprint library *(default - not output to BoM file)* * Datasheet - Component datasheet extracted either from user-included data, or from part library **User Fields** @@ -51,4 +51,10 @@ Multiple BoM output formats are supported: * TSV (Tab separated values) * TXT (Text file output with tab separated values) * XML -* HTML \ No newline at end of file +* HTML + +### Configuration File +BoM generation options can be configured (on a per-project basis) by editing the *.bom* file in the PCB project directory. This file is generated the first time that the KiBoM script is run, and allows configuration of the following options. +* Number Rows: Add row numbers to the BoM output +* Ignore DNF: Component groups marked as 'DNF' (do not fit) will be excluded from the BoM output +* Ignore Columns: A list of columns can be marked as 'ignore', and will not be output to the BoM file. By default, the *Part_Lib* and *Footprint_Lib* columns are ignored. \ No newline at end of file