branch: externals/vc-jj
commit 7fb924da2898616abbff755cf28b4ede3e3f3ff0
Author: Rudi Schlatte <r...@constantly.at>
Commit: Rudi Schlatte <r...@constantly.at>
Adapt documentation to elpa's standards
- elpa ignores README.md when getting package descriptions; use
README.org instead
- For recent changes, elpa a NEWS file instead of CHANGELOG.md; rename
and reformat so the elpa announcement mail looks nice.
---
CHANGELOG.md | 35 -----------------------------------
NEWS.org | 11 +++++++++++
README.md | 23 -----------------------
README.org | 23 +++++++++++++++++++++++
4 files changed, 34 insertions(+), 58 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index 7d685a3a0f..0000000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a
Changelog](https://keepachangelog.com/en/1.1.0/).
-
-## [Unreleased]
-
-### Added
-
-### Changed
-
-### Deprecated
-
-### Removed
-
-### Fixed
-
-### Security
-
-## [0.2] - 2025-04-18
-
-### Fixed
-
-- Properly escape filenames containing jj fileset operator characters.
-
-## [0.1] - 2025-03-16
-
-### Added
-
-- First released version.
-
-[unreleased]: https://codeberg.org/emacs-jj-vc/vc-jj.el/compare/v0.2...HEAD
-[0.2]: https://codeberg.org/emacs-jj-vc/vc-jj.el/compare/v0.1...v0.2
-[0.1]: https://codeberg.org/emacs-jj-vc/vc-jj.el/src/tag/v0.1
diff --git a/NEWS.org b/NEWS.org
new file mode 100644
index 0000000000..e153d7f3b1
--- /dev/null
+++ b/NEWS.org
@@ -0,0 +1,11 @@
+* Recent changes
+
+** [[https://codeberg.org/emacs-jj-vc/vc-jj.el/compare/v0.1...v0.2][0.2]] -
2025-04-18
+
+*** Fixed
+
+- Properly escape filenames containing jj fileset operator characters.
+
+** [[https://codeberg.org/emacs-jj-vc/vc-jj.el/src/tag/v0.1][0.1]] - 2025-03-16
+
+- First released version.
diff --git a/README.md b/README.md
deleted file mode 100644
index 9d1edb096d..0000000000
--- a/README.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# jj (Jujutsu) integration with Emacs vc.el and project.el
-
-Work-in-progress support for `vc.el` and `project.el` implementations
-for the [Jujutsu](https://github.com/jj-vcs/jj) version control
-system.
-
-## Contributing
-
-We welcome bug reports and pull requests! Since `vc-jj.el` is
-distributed via GNU elpa, non-trivial code contributions need to 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,
-for example via `jj config edit --user` or `jj config edit --repo`:
-
-```toml
-[ui]
-diff.format = "git"
-conflict-marker-style = "git"
-```
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..5200ad40ea
--- /dev/null
+++ b/README.org
@@ -0,0 +1,23 @@
+* jj (Jujutsu) integration with Emacs vc.el and project.el
+
+Work-in-progress support for =vc.el= and =project.el= implementations for
+the [[https://github.com/jj-vcs/jj][Jujutsu]] version control system.
+
+** Contributing
+
+We welcome bug reports and pull requests! Since =vc-jj.el= is
+distributed via GNU elpa, non-trivial code contributions need to 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 Jujutsu
+configuration, for example via =jj config edit --user= or =jj config edit
+--repo=:
+
+#+begin_src toml
+[ui]
+diff.format = "git"
+conflict-marker-style = "git"
+#+end_src
