Skip to content

Commit dda00e5

Browse files
committed
Update ChangeLog and README
1 parent d4e3da6 commit dda00e5

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
66
### Added
77

88
- Support for Yosys 0.11 cells `$aldff`, `$aldffe`
9+
- Added a function `yosys2digitaljs` for converting a Yosys JSON output obtained elsewhere, without running Yosys locally
910

1011
## [0.5.0] -- 2021-10-06
1112

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ The generated JSON is printed on standard output.
2525
# API
2626
Yosys2digitaljs can be used as a library. The API is promise (or async/await) based. Available functions are:
2727

28-
- `process_sv(sv_text)` - converts a single SystemVerilog source passed as a string.
29-
- `process_files(texts)` - converts multiple Verilog/SystemVerilog sources. The `texts` parameter is an object, with keys being file names, and corresponding values containing the file contents as strings. Example: `{ 'test.sv': 'module test; ...' }`.
30-
- `process(filenames, dirname)` - converts Verilog/SystemVerilog sources saved on the filesystem under names `filenames` in the directory `dirname`.
28+
- `yosys2digitaljs(json, options)` - converts the Yosys JSON output `json` (passed as an JS object) to a DigitalJS representation of the same circuit.
29+
- `process_sv(sv_text, options)` - converts a single SystemVerilog source passed as a string.
30+
- `process_files(texts, options)` - converts multiple Verilog/SystemVerilog sources. The `texts` parameter is an object, with keys being file names, and corresponding values containing the file contents as strings. Example: `{ 'test.sv': 'module test; ...' }`.
31+
- `process(filenames, dirname, options)` - converts Verilog/SystemVerilog sources saved on the filesystem under names `filenames` in the directory `dirname`.
3132

3233
The functions return a promise, which fulfills with an object value with following keys:
3334

0 commit comments

Comments
 (0)