Skip to content

Commit

Permalink
README - Add dependency_overrides snippet (superlistapp#1542)
Browse files Browse the repository at this point in the history
  • Loading branch information
angelosilvestre authored and dxvid-pts committed Feb 11, 2024
1 parent 53e2e98 commit 6ab48a9
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

<p align="center">Super Editor was initiated by <a href="https://superlist.com">Superlist</a> and is implemented and maintained by the <a href="https://flutterbountyhunters.com">Flutter Bounty Hunters</a>, Superlist, and the contributors.</p>



<hr>

<p align="center">Do you use Flutter's <b>stable</b> branch? Be sure to checkout <code>super_editor</code>'s <b><a href="https://github.com/superlistapp/super_editor/commits/stable">stable</a></b> branch, for compatibility.<br>Do you use Flutter's <b>master</b> branch? Be sure to checkout <code>super_editor</code>'s <b><a href="https://github.com/superlistapp/super_editor/commits/main">main</a></b> branch, for compabitility.</p>
Expand All @@ -19,9 +17,9 @@

<h2 align="center">Super Editor & Super Text Field</h2>

Please see the [SuperEditor README](super_editor/README.md) about how to use the packages, or run the [sample editor](super_editor/example/README.md).
Please see the [SuperEditor README](super_editor/README.md) about how to use the packages, or run the [sample editor](super_editor/example/README.md).

A web demo is accessible at [https://superlist.com/SuperEditor](https://superlist.com/SuperEditor/).
A web demo is accessible at [https://superlist.com/SuperEditor](https://superlist.com/SuperEditor/).

<hr>

Expand All @@ -34,3 +32,31 @@ You might notice that this is a mono-repo, which includes multiple projects. Tha
<a href="attributed_text/README.md"><img src="https://user-images.githubusercontent.com/7259036/170845473-268655ac-3fec-47c1-86ab-41a1391aa1e0.png" width="300" alt="Attributed Text"></a>
</p>

<h2 align="center">Mono-repo Versioning</h2>
If you have compilation errors when using the GitHub version of super_editor, try overriding dependencies for the other packages in this mono-repo, e.g., super_editor_markdown, super_text_layout, and attributed_text. This project often makes changes to multiple packages within the mono-repo, which requires that you use the latest main or stable version of every package.

You can override your dependencies as follows:

```yaml
dependency_overrides:
super_editor:
git:
url: https://github.com/superlistapp/super_editor
path: super_editor
ref: stable # or "main"
super_editor_markdown:
git:
url: https://github.com/superlistapp/super_editor
path: super_editor_markdown
ref: stable
super_text_layout:
git:
url: https://github.com/superlistapp/super_editor
path: super_text_layout
ref: stable
attributed_text:
git:
url: https://github.com/superlistapp/super_editor
path: attributed_text
ref: stable
```

0 comments on commit 6ab48a9

Please sign in to comment.