#+TITLE: kicad_bom
#+AUTHOR: Peter Polidoro
#+EMAIL: peterpolidoro@gmail.com

* Package Information
  - Name :: kicad_bom
  - Version :: 3.1.1
  - License :: BSD
  - URL :: https://github.com/janelia-pypi/kicad_bom
  - Author :: Peter Polidoro
  - Email :: peterpolidoro@gmail.com

  KiCad Python module for generating bill of materials in multiple
  formats. Based on some code by Jean-Pierre Charras.

* Example Use
** Linux and Mac OS X

   #+BEGIN_SRC sh
     source ~/venvs/kicad/bin/activate
     cd <kicad_project_directory>
     kicad_bom
   #+END_SRC

** Windows

   #+BEGIN_SRC sh
     C:\venvs\kicad\Scripts\activate
     cd <kicad_project_directory>
     kicad_bom
   #+END_SRC
* Installation

  [[https://github.com/janelia-pypi/python_setup]]

** Linux and Mac OS X

   #+BEGIN_SRC sh
     mkdir ~/venvs/
     python3 -m venv ~/venvs/kicad
     source ~/venvs/kicad/bin/activate
     pip install kicad_bom
   #+END_SRC

** Windows

   #+BEGIN_SRC sh
     python3 -m venv C:\venvs\kicad
     C:\venvs\kicad\Scripts\activate
     pip install kicad_bom
   #+END_SRC
