Welcome to the official documentation of JITX. Here you'll find function references, tutorials, how-to guides, FAQs, and all of the information you need to learn and use JITX.
JITX is a tool that helps you design PCBs with automation of circuit design, component selection, component modeling, pin assignment, geometric constraints, schematic drafting, schematic verification, and more. You can design at the system level and automate the rest.
If you're new to using JITX, welcome! A background in electrical engineering is all you need to get up and running designing boards in JITX.
For new users, we recommend reading through this page, then starting with the Tutorials, which will give you a quickstart to setting up and using JITX for your designs. Specifically, checkout the workflows below for a path to get started:
- Setup and install JITX with JITX Installation Instructions.
- Design a basic board in JITX and export to CAD - do Quickstart 1
- Organize your schematic and layout with Quickstart II: Organize a schematic
- Export to CAD (KiCad or Altium) by following Exporting to CAD
- Layout the PCB in CAD the same way that you normally would.
- Import your design from CAD
- Revise your design in JITX
- Export your design back into CAD
- Follow First Time User, Checking Designs, and Creating Components Workflow.
- Follow Learn JITX
- Follow Quickstart III: Check a design
Use the left side bar to move around the documentation (you can open the left side bar by clicking the ☰ in the top left of this page), and use the search bar above to search for functions, questions, tutorials, etc.
Follow this tutorial to get JITX setup on your own system: Installing JITX
If you haven't been able to answer your questions by looking through the tutorials and using the search bar above, you can get help from JITX Inc. directly using one of the methods below.
This method assumes you have JITX installed in VSCode.
- Open VSCode.
- Click the "JITX" extension icon in the left side bar.
- Click the hamburger menu in the top left that looks like this: ☰
- Click "Request help"
- Fill out the form. We'll get back to you right away.
If the VSCode extension method doesn't work for you, you can fill out this form to request help, we'll get back to you right away: https://support.jitx.com/hc/en-us/requests/new
- JITX Official Website
- JITX Github
- Learning Stanza (the programming language that JITX uses): http://lbstanza.org/stanzabyexample.html
- JITX Demo Videos
The organization of the docuementation is as follows (see the side bar for a full index of the documentation).
- JITX Documentation Introduction - intro to the docs.
- Reference materials are the low-level documentation of JITX. The Reference materials refer to technical descriptions of JITX's machinery and its operation. Things like descriptions of key classes, functions, and APIs
- Tutorials are small, rewarding projects that help you learn JITX.
- How-To Guides
- How-to guides take you through a series of steps to help you solve a specific real world problem. They are tools for practitioners who are trying to get something done using JITX.
- Open Component Database (OCDB)
- The Open Components Database (OCDB) is an open database of components and circuit generators for automated circuit board design. This section provides users with quick access to information on how to use everything in OCDB with examples.
- BOM Import Data Format
- Describes how to import a BOM.
- Example Designs
- The example designs consists of projects exemplifying common use cases.
- Frequently Asked Questions
- This section contains questions that users frequently encounter.
You can access the index of the entire docs in the left hand side panel.