GitHub - epfl-systemf/librrd: Railroad diagram (RRD) layout library. Try it out at https://systemf.epfl.ch/etc/librrd/.

Repository navigation

librrd

Public

About

Railroad diagram (RRD) layout library. Try it out at https://systemf.epfl.ch/etc/librrd/.

6 stars

0 watching

Name		Name	Last commit message	Last commit date
cli/examples		cli/examples
gui		gui
project		project
src/main/scala		src/main/scala
.gitignore		.gitignore
LICENSE		LICENSE
NOTICE		NOTICE
README		README
build.sbt		build.sbt
design		design
package-lock.json		package-lock.json
package.json		package.json

Repository files navigation

LibRRD
======

Setup
-----

- To build the project, you need Scala (v3.3.6) and SBT.
  Follow official instructions at https://www.scala-lang.org/download/

- To run the CLI, you need Node.js (v20) and NPM.
  Follow official instructions at https://nodejs.org/en/download/
  Then, run `npm install`.

- To use the GUI, you need a webserver.
  A simple one is provided with Python, which you can start with:
    python3 -m http.server --directory gui/ 8080

- The project automatically fetches the dependencies documented in NOTICE.
  node-canvas is only needed for the CLI.


Build
-----

1. `sbt deploy`


Help
----

Help for the GUI is available by clicking the help button in the top right
corner.
Help for the CLI is available by running `node cli/cli.js --help`.