Skip to content

update docs #276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mmdjvnm wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update docs #276

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,24 @@ set KICAD_SYMBOL_DIR=C:\Program Files\KiCad\share\kicad\symbols
3. **Get help**: Join discussions in our [user forum](https://github.com/devbisme/skidl/discussions)
4. **Convert existing designs**: Use the `netlist_to_skidl` tool to convert KiCad designs to SKiDL



## Simple SKiDL Example for Beginners

Here is a minimal example that shows how to define a resistor and an LED connected in series using SKiDL:

```python
from skidl import *

# Create a resistor and LED.
r = Part('device', 'R', value='1k')
led = Part('device', 'LED')

# Connect resistor to LED.
r[1] += led[1]
r[2] += led[2]

# Generate the netlist.
generate_netlist()