Skip to content

Commit dc72b29

Browse files
Documentation update
1 parent 7baaaf0 commit dc72b29

20 files changed

+957
-8
lines changed

.vscode/settings.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,5 +93,6 @@
9393
"*.txt": "c",
9494
"cerrno": "cpp",
9595
"*.def": "cpp"
96-
}
97-
}
96+
},
97+
"asciidoc.extensions.enableKroki": true
98+
}

Makefile

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,14 @@ clean:
1414
run: build
1515
$(MAKE) -C examples --no-print-directory run
1616

17-
.PHONY: all build clean run
17+
header:
18+
insert-license --license-filepath=LICENSE --use-current-year --comment-style "#" $$(find . -name "*.py")
19+
20+
pdf:
21+
asciidoctor-pdf -D docbuild -r asciidoctor-kroki -r asciidoctor-mathematical -a allow-uri-read -a mathematical-format=svg -a pdf-theme=pdf -a pdf-themesdir=. doc/index.adoc
22+
23+
html:
24+
asciidoctor -D docbuild -r asciidoctor-kroki -a allow-uri-read doc/index.adoc
25+
26+
.PHONY: all build clean run header pdf html
1827
.SILENT:

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ With ASysC, you can write your own components by using algebraic descriptions.
88
For instance, consider the resistor declaration:
99

1010
NAME.CR(@1,@2,R) := {
11-
NAME.U=ACROSS(@1,@2);
12-
NAME.I=THROUGH(@1,@2);
13-
NAME.U=R*NAME.I
11+
NAME.U = ACROSS( @1, @2 );
12+
NAME.I = THROUGH( @1, @2 );
13+
NAME.U = R * NAME.I
1414
};
1515

1616
For more examples, see the [component.rule](https://github.com/analog-system-compiler/lightcas/blob/3b8b692d76aa31503276b9a10259393b8f68dcf0/rules/components.rule) and [examples](examples) directories.
@@ -31,8 +31,8 @@ This command generates Python code containing equations for AC simulation.
3131
- make
3232

3333
### Python requirements
34-
- numpy
35-
- matplotlib
34+
- numpy
35+
- matplotlib
3636

3737
## Getting source code
3838
```bash

0 commit comments

Comments
 (0)