branch: externals/vc-jj
commit b46fc7ea38d396f0346b0a840b482622aa2cd066
Author: Rudi Schlatte <r...@constantly.at>
Commit: Rudi Schlatte <r...@constantly.at>
Update README somewhat
---
README.md | 26 ++++++++++++++++++++------
1 file changed, 20 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 82d199492d..b204b7a48c 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,24 @@
# jj (Jujutsu) integration with Emacs vc.el and project.el
-A proof of concept of `vc.el` and `project.el` implementations for
-[Jujutsu](https://github.com/martinvonz/jj).
+Work-in-progress support for `vc.el` and `project.el` implementations
+for the [Jujutsu](https://github.com/jj-vcs/jj) version control
+system.
-## Project status
+## Contributing
-This will probably remain only a proof of concept without any serious
-further development, but should serve as a good starting point
-for others.
+We welcome bug reports and pull requests! Since we plan to contribute
+the code upstream, either to GNU elpa or to core Emacs, non-trivial
+code contributions should have the standard FSF copyright assignment
+in place.
+
+## Jujutsu configuration hints
+
+Emacs has built-in support for git-style diff and conflict markers, so
+you might want to set the following options in your configuration,
+e.g., via `jj config edit --user` or `jj config edit --repo`:
+
+```toml
+[ui]
+diff.format = "git"
+conflict-marker-style = "git"
+```
