From e1ef0331a3558e02df8190103aeaf1c2a9705c7a Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Tue, 3 Aug 2021 11:48:36 +0200 Subject: Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4f61cad..0191234 100644 --- a/README.md +++ b/README.md @@ -190,6 +190,17 @@ By default, org-roam-ui will try to open itself in your default browser. To disa ## FAQ 🗨 +## Q: Aaaaand it broke: what do? + +Sorry! This is still alpha software, so expect it to break from time to time. Best thing you can try is to remove your settings by going to "Storage > Local Storage" on Firefox or "Application > Local Storage" on Chromium and deleting everything there. + +If the issue still persists, please file a bug report with +1. Your browsers console log +2. Your browsers +3. What you were doing when it broke + +and we'll try to help you ASAP! + ### Q: Graph Slow! Faster? While we try to optimize the display of the graph, there is only so much we can do. For largish networks (>2k nodes) dragging the graph around a lot can cause some performance issues, but there are a few things you can do to speed it up. @@ -228,7 +239,7 @@ In our experience, once the graph has actually settled and nothing needs to be r ### Q: Some of my links are not showing up? -At the moment we aren't showing citation links made with `org-roam-bibtex` yet, but we will soon! +Links which do not refer to a valid id are filtered out to prevent crashes. In the future we will handle this a bit more gracefully by notifying you about this, but for now we're just removing them. ### Q: Will you implement X? -- cgit v1.2.3 From bf0fc533229cab26d333c134c16b0994bde7215b Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Tue, 3 Aug 2021 14:42:36 +0200 Subject: fix: emacs > 27 => emacs >= 27 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 74c8674..430ab0f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Org-Roam-UI is meant a successor of [org-roam-server](https://github.com/org-roa `org-roam-ui` is not (yet!) on MELPA. Should your Emacs miss any of the dependencies, please install them manually! -org-roam-ui requires `org-roam`, `websocket`, `simple-httpd`, `f` and Emacs >27 for fast JSON parsing. +org-roam-ui requires `org-roam`, `websocket`, `simple-httpd`, `f` and Emacs >= 27 for fast JSON parsing. ### Manually -- cgit v1.2.3