Skip to content

Document tscircuit user-facing tools #649

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
junn-dev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document tscircuit user-facing tools #649

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
18 changes: 18 additions & 0 deletions docs/contributing/overview-of-projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ sidebar_position: 2
description: Explore the key tscircuit repositories including core libraries, tools, and web components that power the ecosystem.
---

## User-Facing Tools

These are the tools most users interact with directly when creating, previewing,
or ordering circuits.

| Tool | Repository | What Users Do With It |
| ---- | ---------- | --------------------- |
| Online editor | [tscircuit/tscircuit.com](https://github.com/tscircuit/tscircuit.com) | Create and edit circuit projects in the browser |
| CLI | [tscircuit/cli](https://github.com/tscircuit/cli) | Run local projects, build outputs, install packages, and publish packages |
| Runframe | [tscircuit/runframe](https://github.com/tscircuit/runframe) | Embed runnable circuit previews in docs, websites, and apps |
| PCB viewer | [tscircuit/pcb-viewer](https://github.com/tscircuit/pcb-viewer) | Inspect generated PCB layouts interactively |
| 3D viewer | [tscircuit/3d-viewer](https://github.com/tscircuit/3d-viewer) | Review 3D board previews and component placement |
| Autorouting.com | [tscircuit/autorouting](https://github.com/tscircuit/autorouting) | Test and improve PCB routing algorithms |
| Circuit JSON viewer | [tscircuit/circuit-json](https://github.com/tscircuit/circuit-json) | Work with the generated circuit data format used between tools |
| Package registry | [tscircuit/registry](https://github.com/tscircuit/registry) | Find and publish reusable tscircuit packages |

## Core Repositories

| Repo | Description | Open Issues |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [tscircuit/core](https://github.com/tscircuit/core) | Core library that powers tscircuit, handles conversion of React components into circuit boards | [![GitHub issues](https://img.shields.io/github/issues/tscircuit/core)](https://github.com/tscircuit/core/issues) |
Expand Down
Loading