Skip to content

Commit

Permalink
Add "File Format" section.
Browse files Browse the repository at this point in the history
  • Loading branch information
KmolYuan committed Nov 20, 2023
1 parent 68a272a commit 65d758f
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ cargo run --release -- --help

### WebAssembly

Powered by `trunk` (<https://github.com/thedodd/trunk>), a Rust CLI tool for creating bin-type WASM projects.
Powered by [`trunk`](<https://github.com/thedodd/trunk>), a Rust CLI tool for creating bin-type WASM projects.

Run those scripts from the repository:

Expand All @@ -79,3 +79,26 @@ trunk build --release
```

The application package will be deployed in the `dist` directory.

## File Format

Four🍀bar uses a custom file format to store the linkage data. The file is a plain text file of [RON](https://github.com/ron-rs/ron) syntax.

### Synthesis Target Format

The target coupler curve can be input from:

+ CSV `.csv` file
+ RON `.ron` file as a linkage to generate a coupler curve

The file name should be `name.mode.ext` pattern, where

+ `name` is the name of the case, can be any string
+ `mode` is the mode of the target curve, can be `closed`, `open`, and `partial`
+ `ext` is the file extension, can be `csv` or `ron`

For example, `example.closed.csv` is a target closed curve in CSV format.

### Figure Configuration

The figure configuration is a RON file with the extension `.fig.ron`. Four🍀bar GUI can import figure configurations to generate linkage plots, and the `syn` command will redraw the linkage result without cleaning if the figure configuration exists.

0 comments on commit 65d758f

Please sign in to comment.