Skip to content

Commit d9bb0c5

Browse files
reformat docs
1 parent 470615d commit d9bb0c5

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

format.md

+30-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
11
# Schemascii Format
22

3-
The diagram is made of 3 components: wires, 1-, 2-, and 3-terminal components, and larger components (IC's, etc.) drawn as boxes.
3+
## Wires
44

5-
Wires are simply lines drawn using dashes or pipe symbols. A corner or wire join (drawn as a dot) is notated by an asterisk (`*`), and crossed wires (not joined) are notated with a `)` or simply broken to allow the other wire to pass. Examples:
5+
Wires are simply lines drawn using dashes or pipe symbols.
6+
7+
A corner or wire join (drawn as a dot) is notated by an asterisk (`*`)
8+
9+
Crossed wires (not joined) are notated with a `)` or simply broken to allow the other wire to pass. Examples:
610

711
```txt
8-
Crossed: Joined: Corner: Corner: Crossed: Crossed:
9-
| | | | | |
10-
---)--- ---*--- *--- |--- ------- ---|---
11-
| | | |
12+
Crossed: Joined: Corner: Crossed: Crossed: Dangling ends:
13+
| | | | | |
14+
---)--- ---*--- *--- ------- ---|--- |---
15+
| | | |
1216
```
1317

14-
Small components are notated with their reference designator: one or more uppercase letters followed by an ID, which can either be a number, or a period followed by some text. They are always written horizontally even if the terminals are on the top and bottom. IDs are allowed to be duplicated and result in the same component values. Components can be padded on either side with `#`'s to make them bigger.
18+
## Components
19+
20+
### Small components
21+
22+
Small components are notated with their reference designator: one or more uppercase letters followed by an ID, which can either be a number, or a period followed by some text.
23+
24+
They are always written horizontally even if the terminals are on the top and bottom.
25+
26+
IDs are allowed to be duplicated and result in the same component values.
27+
28+
Components can be padded on either side with `#`'s to make them bigger.
1529

1630
Examples:
1731

@@ -25,11 +39,17 @@ Examples:
2539

2640
Components are able to accept "flags", which are other punctuation characters and lowercase letters touching them.
2741

28-
Polarized components (caps, diodes, etc.) accept a `+` to indicate the polarity, whereas transistors use lowercase letters to indicate collector/emitter/base (for BJTs) or source/gate/drain (for FETs).
42+
* Polarized components (caps, diodes, etc.) accept a `+` to indicate the polarity,
43+
* Transistors use lowercase letters to indicate collector/emitter/base (for BJTs) or source/gate/drain (for FETs).
44+
45+
### Big components
46+
47+
* Big components are indicated with a box made of `~` (top and bottom), `:` (sides), and `.` (corners).
48+
* The inside of the box can contain anything you want, but it must include exactly one reference designator as to what component it is.
2949

30-
Big components are indicated with a box made of `~` (top and bottom), `:` (sides), and `.` (corners). The inside of the box can be anything you want, but it must include exactly one reference designator as to what component it is.
50+
## Reference designators
3151

32-
To include component values, pin numbers, etc, somewhere in the drawing but not touching any wires or other components, you can write component values - these are formatted as the reference designator (same as in circuit) followed by a `:` and the value parameter (which stops at the first whitespace). I usually put these in a "BOM section" below the circuit itself but you could also put them right next to the component.
52+
To include component values, pin numbers, etc, somewhere in the drawing but not touching any wires or other components, you can write component values - these are formatted as the reference designator (same as in circuit) followed by a `:` and the value parameter (which stops at the first whitespace). *I usually put these in a "BOM section" below the circuit itself but you could also put them right next to the component.*
3353

3454
For simple components, this is usually just a value rating. For more specific components (mostly semiconductor devices) this is usually the part number.
3555

0 commit comments

Comments
 (0)