From 141a1f7013ba8b0fa6fa78629d576eee508a0624 Mon Sep 17 00:00:00 2001 From: osvalds Date: Fri, 29 Sep 2023 18:38:15 +0300 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ba9a9b5..edb18d6b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ -# Important! - -**This project does not have a maintainer or active project members. There won’t be any support or attention to pull requests. Please do not contact previous maintainers unless you are qualified and have the resources to make a serious commitment to fully take over ownership of the project.** +# Whimsical fork of dagre + +This fork was made to support a [new feature](https://github.com/WhimsicalCode/dagre/commit/f8f9511069a7603e00bece24b49de33cba1d04b5) in `dagre` - variable padding for clusters. +This enables us to have a better looking layout when calculating layout with `dagre`. +This fork is made on the `0.8.6` version because the new maintainers of `dagre` have started to +use private class members in `graphlib` (dependency of `dagre`) which is not supported by +the Google Closure Compiler. When these changes were applied to the newer (`1.0.5-pre`) version, cluster children +`ranksep` (the vertical distance between nodes) looked very different compared to `0.8.6` + +## How to release a new version +1. Make changes +2. Update version in `package.json` +3. Run `make dist` +4. Commit changes +5. Tag commit with new version +6. Push commit and tag +7. Create a new release on GitHub (This will trigger gha that will publish to github packages).