Documentation was added.

hildogjr · Jul 2, 2015 · 68f35b6 · 68f35b6
1 parent 7b5fe98
commit 68f35b6
Show file tree

Hide file tree

Showing 6 changed files with 337 additions and 6 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -3,7 +3,7 @@
 History
 -------
 
-0.1.0 (2015-06-15)
+0.1.0 (2015-06-30)
 ---------------------
 
 * First release on PyPI.
diff --git a/README.rst b/README.rst
@@ -1,5 +1,5 @@
 ===============================
-kicost
+KiCost
 ===============================
 
 .. image:: https://img.shields.io/travis/xesscorp/kicost.svg
@@ -9,12 +9,25 @@ kicost
         :target: https://pypi.python.org/pypi/kicost
 
 
-Calculate the cost of a KiCAD project.
+KiCost is intended to be run as a script for generating part-cost spreadsheets for
+circuit boards developed with KiCad.
 
 * Free software: MIT license
 * Documentation: https://kicost.readthedocs.org.
 
 Features
 --------
 
-* TODO
+* Processes the BOM XML file from your KiCad schematic to create a part-cost spreadsheet by
+  scraping the web sites of several popular distributors for price and inventory data 
+  (Digi-Key, Mouser and Newark/Element14 are currently supported).
+* The spreadsheet contains quantity-adjusted pricing from each distributor for 
+  individual parts and the total board.
+* Enter the number of boards to be built in a spreadsheet cell and all the pricing
+  for the total board and individual parts is updated.
+* The spreadsheet also shows the current inventory on-hand for each part at each distributor.
+* Enter the quantity of each part that you want to purchase from each distributor and
+  lists of part numbers and quantities will appear in formats that you can cut-and-paste
+  directly into the website ordering page of each distributor.
+
+.. image:: block_diag.png
diff --git a/block_diag.png b/block_diag.png
diff --git a/docs/block_diag.png b/docs/block_diag.png
diff --git a/docs/block_diag.svg b/docs/block_diag.svg
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,6 +2,25 @@
 Usage
 ========
 
-To use kicost in a project::
+KiCost is mainly intended to be run as a script for generating part-cost spreadsheets for
+circuit boards developed with KiCad. Typical use is as follows:
 
-    import kicost
+1. For each part in your schematic, create a field called `manf#` and set the field value
+   to the manufacturer's part number. (You can reduce the effort of adding this information to individual parts by
+   placing the `manf#` field and value into the part info in the schematic library so it gets applied globally.)
+2. Output a BOM from your KiCad schematic. This will be an XML file. For this example, say it is `schem.xml`.
+3. Process the XML file with KiCost to create a part-cost spreadsheet named `schem.xlsx` like this::
+
+     python kicost -i schem.xml
+
+4. Open the `schem.xlsx` spreadsheet using Microsoft Excel, LibreOffice Calc, or Google Sheets.
+   Then enter the number of boards that you need to build and see
+   the prices for the total board and individual parts when purchased from 
+   several different distributors (KiCost currently supports Digi-Key, Mouser and Newark/Element14).
+   All of the pricing information reflects the quantity discounts currently in effect at
+   each distributor.
+   The spreadsheet also shows the current inventory of each part from each distributor so you can tell
+   if there's a problem finding something and an alternate part may be needed.
+5. Enter the quantity of each part in your schematic that you want to purchase from each distributor.
+   Lists of part numbers and quantities will appear in formats that you can cut-and-paste
+   directly into the website ordering page of each distributor.