Skip to content
This repository has been archived by the owner on Oct 2, 2020. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
General improvements to add valuable details and clarifications
  • Loading branch information
ElectricRCAircraftGuy committed Aug 13, 2018
1 parent 0a797c5 commit 01eeb6d
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Expand Up @@ -42,21 +42,21 @@ How to use
## Schematic Library Checker

# first get into schlib directory
cd schlib
cd kicad-library-utils/schlib

# run the script passing the files to be checked
./checklib.py path_to_lib1 path_to_lib2

# to check a specific component you can use the -c flag
./checklib.py -c component_name path_to_lib1

# run the following command to see other options
# run the following 'h'elp command to see other options
./checklib.py -h

## Adding Part Number (PN) to Schematic Files

# first get into sch directory
cd sch
cd kicad-library-utils/sch

# use the following command to add empty "MPN" fields in the schematic files
./add_part_number.py path_to_sch1 path_to_sch2
Expand All @@ -67,34 +67,37 @@ How to use
# manually add the MPN field in the Collated Components section (for example)
./add_part_number.py --bom-csv=path_to_bom_csv path_to_sch_files/*.sch

# run the following command to see other options
# run the following 'h'elp command to see other options
./add_part_number.py -h


## Footprint Checker

# first get into pcb directory
cd pcb
cd kicad-library-utils/pcb

# run the script passing the files to be checked
./check_kicad_mod.py path_to_fp1 path_to_fp2
./check_kicad_mod.py path_to_fp1.kicad_mod path_to_fp2.kicad_mod

# Add `-v`, `-vv`, or `-vvv` for extra verbose output. The most useful is `-vv`, which explains in details the violations. Ex:
./check_kicad_mod.py path_to_fp1.kicad_mod path_to_fp2.kicad_mod -vv

# run the following command to see other options
# run the following 'h'elp command to see other options
./check_kicad_mod.py -h


## 3D Coverage Checker

# first get into pcb directory
cd pcb
cd kicad-library-utils/pcb

# run the script to check all footprints
./check_3d_coverage.py

# run the script to check only the specified .pretty folder
./check_3d_coverage.py --prettty Housings_SOIC

# run the following command to see other options
# run the following 'h'elp command to see other options
./check_3d_coverage.py -h


Expand Down

0 comments on commit 01eeb6d

Please sign in to comment.