Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hamza-algohary authored Jan 9, 2023
1 parent 2cdb2c5 commit e412d00
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
<<<<<<< HEAD
# Circuit-Simulator
A simple yet powerful circuit cimulator for the 21th century.

It currently provides CLI frontend, and we're working to release the GUI as soon as possible.
More on how to use this program later.
=======
##Overview
## Overview
Circuit Simulator is a circuit simulation program. It's written in Java, hence it's available on Windows Mac & Linux. It provides both CLI and GUI frontends. It supports multiple components, including non-linear and frequency-varrying components.
## Installation
You can find zip binary package in github releases.
Expand Down Expand Up @@ -35,7 +28,9 @@ r 0,1 1,1 5
r 1,0 1,1 5
```
Which corresponds to the following circuit:

![Simple Circuit Imgae](screenshots/circuit.svg)

To run the program with that file, navigate to bin directory then fire up a terminal and type:
`./run.sh test.txt`
if you're running it for the first time you need to type this command first:
Expand Down Expand Up @@ -89,7 +84,7 @@ Where variable name is either __node voltage__ or __branch current__.
Node voltage is "V" followed by node coordinate
Branch current is "I" followed by start then end coordinates of the branch.

####How to determine current direction?
#### How to determine current direction?
Let current name be `Ix1,y1:x2,y2`, if the value is positive then it's flowing from x1,y1 to x2,y2, otherwise it's flowing the other way.

## The Oscilliscope
Expand All @@ -115,4 +110,3 @@ This is just a prototype of the planned GUI, the end result will be (hopefully)

![Screenshot](screenshots/main_window.png)

>>>>>>> e18b782 (Added a meaningful README)

0 comments on commit e412d00

Please sign in to comment.