PCB READ ME FILES

What to Include in a PCB README File

Here’s a comprehensive checklist of what to include:

1. Project Information

Project name
Revision/version number
Date of submission
Designer/company contact info

2. Board Specifications

Board dimensions (length × width)
Board thickness (e.g., 1.6 mm)
Number of layers (e.g., 2-layer, 4-layer)
Copper weight (e.g., 1 oz, 2 oz)
Material type (e.g., FR4, Rogers)

3. Surface Finish

Specify the desired finish:

HASL (Hot Air Solder Leveling)
ENIG (Electroless Nickel Immersion Gold)
OSP (Organic Solderability Preservative)

4. Solder Mask & Silkscreen

Solder mask color (e.g., green, black, white)
Silkscreen color (e.g., white, black)
Sides: Indicate if silkscreen is on top, bottom, or both

5. Drill Information

Minimum hole size
Plated vs. non-plated holes
Via types (standard, microvia, blind/buried)

6. Tolerance Requirements

Hole size tolerance
Outline tolerance
Impedance control (if applicable)

7. Panelization Instructions (if needed)

V-scoring or tab-routing
Number of boards per panel
Fiducial marks and tooling holes

8. Special Instructions

Any non-standard features:

Controlled impedance
Edge plating
Cut-outs or slots
Carbon ink or peelable mask

9. File List

A list of all included files with descriptions:
Plain Text
Quartz_TopCopper.gtl – Top copper layer
Quartz_BottomCopper.gbl – Bottom copper layer
Quartz_SolderMaskTop.gts – Top solder mask
Quartz_Drill.drl – Drill file
Quartz_Outline.gm1 – Board outline
Show more lines

10. Assembly Notes (if applicable)

Pick-and-place file format
Component orientation
Polarity markings
Moisture sensitivity level (MSL)

Tips for Creating a Good README

Keep it clear and concise — avoid jargon unless necessary.
Use bullet points or tables for readability.
Include units (mm, mils, oz) consistently.
Double-check that the README matches the actual Gerber files.
Save as .txt or .pdf — both are widely accepted.