Skip to content

Commit d2ced11

Browse files
committed
Tweaks to README.
1 parent 7ea185c commit d2ced11

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# CellML conversion for the CellDL Editor
1+
# CellML generation for the CellDL Editor
22

3-
This package provides a Javascript function to convert CellDL bond-graph models into CellML. It does so by bundling the bg2cellml Python package with Pyodide, allowing it to be used in a Javascript envirinment.
3+
This package provides a Javascript function to convert [BG-RDF](https://bg-rdf.org/) bond-graph models, created by the CellDL Editor, into [CellML](https://cellml.org). It does so by bundling the [bg2cellml](https://github.com/CellDL/BG-Tools) Python package with [Pyodide](https://pyodide.org), allowing it to be used in a Javascript envirinment.
44

5-
It is intended to be used in conjunction with the `@celldl/editor` Vue 3 component.
5+
It is intended to be used in conjunction with the [@celldl/editor](https://www.npmjs.com/package/@celldl/editor) Vue 3 component.
66

77

88
## Installation
@@ -59,8 +59,7 @@ vue.nextTick().then(async () => {
5959
import { celldl2cellml } from '@celldl/editor-tools'
6060
export type { CellMLOutput } from '@celldl/editor-tools'
6161
62-
const celldl: string = '<svg><!-- Valid CellDL serialisation --></svg>'
63-
62+
const celldl: string = '<svg><!-- Valid CellDL --></svg>'
6463
const celldlUri: string = `https://celldl.org/cellml/${name}` // Some URI to identify the source
6564
6665
const cellmlObject: CellMLOutput = celldl2cellml(`https://celldl.org/cellml/${fileHandle.name}`, celldl)

0 commit comments

Comments
 (0)