Skip to content

davejoshmike/CSharpCircuitry

Repository files navigation

CSharpCircuitry

Welcome to the CSharpCircuitry repository! This project is aimed at providing a set of tools for designing and visualizing electronic circuitry. Think of it as an interactive bread board based in WPF/XAML.

Overview

CSharpCircuitry is designed to facilitate the creation and simulation of electronic circuits. Whether you're a hobbyist, student, or professional engineer, this library aims to make it easier to work with circuit components and simulate their behavior.

Features

  • Component Library: Explore a comprehensive library of electronic components, ranging from basic resistors and capacitors to more complex integrated circuits.

  • Circuit Simulation: Simulate the behavior of your circuits to understand how they will perform under different conditions.

  • Graphical Interface: Visualize your circuits with a graphical interface, making it easier to design and debug.

  • Open Source: CSharpCircuitry is open source, allowing you to contribute to its development and customize it to fit your needs.

Getting Started

To get started with CSharpCircuitry, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/davejoshmike/CSharpCircuitry.git
  2. Explore Examples: Check out the CircuitryRunner directory to explore how to use the project.

  3. Build and Run: Build the solution and run the CircuitryRunner project to see CSharpCircuitry in action.

Documentation

For detailed information on how to use CSharpCircuitry, refer to the documentation.

Contributing

If you're interested in contributing to CSharpCircuitry, please read our contribution guidelines to get started. We welcome bug reports, feature requests, and pull requests.

Current TODOs

  • Console mode: basic command line interface that allows you to create a rudimentary curcuit
  • UI mode: WPF/XAML frontend with the ability to modify the nodes of a circut and view the properties of the nodes
  • Additional components: Currently only basic components like buttons, buzzers and leds are supported. Would love to see this expanded to support additional electrical components.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Have questions or suggestions? Feel free to open an issue or contact the maintainers.

Happy coding with CSharpCircuitry!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages