From 13293ec93eecae4ee06f670aafb902cfb06e92fe Mon Sep 17 00:00:00 2001 From: JenChieh Date: Tue, 18 Feb 2025 22:49:50 -0800 Subject: [PATCH 1/5] docs: Add option to use Eask and add example --- README.md | 52 ++++++++++++++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bebd681..dd4d569 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,11 @@ [![MELPA](http://melpa.org/packages/github-elpa-badge.svg)](http://melpa.org/#/github-elpa) [![MELPA Stable](http://stable.melpa.org/packages/github-elpa-badge.svg)](http://stable.melpa.org/#/github-elpa) - - github-elpa =========== Build and publish your own ELPA repositories with GitHub Pages - - Overview -------- @@ -25,32 +21,46 @@ recipes in [MELPA's format](https://github.com/melpa/melpa#recipe-format), issue just one simple command to update the ELPA repository. - - Quick Start ----------- This section describes how to setup your ELPA repository in your GitHub repository. - ### 0. Prerequisite * A GitHub account, and a GitHub respository that you have a write-permission and can change `Settings` -* [Cask](https://github.com/cask/cask) - +* [Cask](https://github.com/cask/cask) or [Eask](https://github.com/emacs-eask/cli) -### 1. Prepare Cask File +### 1. Prepare Cask/Eask File Put `Cask` file to the root of the GitHub repository. Typically it should look like: - (source gnu) - (source melpa) +```elisp +(source gnu) +(source melpa) + +(depends-on "github-elpa") +``` + +Or `Eask` file, - (depends-on "github-elpa") +```elisp +(source 'gnu) +(source 'melpa) +(depends-on "github-elpa") +``` + +#### [RECOMMENDED] Use Eask to generate the ELPA project + +Execute the following command to generate the ELPA project. + +```sh +eask create elpa +``` ### 2. Add Recipes and Build Archives @@ -93,23 +103,21 @@ accessed as a GitHub Pages. Now it's all done! - Use and Maintainance -------------------- ### Add to Your Repository List - The published ELPA repository URL is `https://.github.io//elpa/`. For example, to use the repository of `github-elpa` itself, add following to your `init.el`: - (setq package-archives - `(,@package-archives - ("github-elpa" . "https://10sr.github.io/github-elpa/elpa/"))) - - +```elisp +(setq package-archives + `(,@package-archives + ("github-elpa" . "https://10sr.github.io/github-elpa/elpa/"))) +``` ### Update Repository @@ -159,6 +167,10 @@ This command will git-commit files in `docs/elpa/` (or the directory | `-t, --tar ` | (Use value from `package-build.el`) | Specify tar executable name to archive files | +Example +------- + +- [JCS-ELPA](https://github.com/jcs-emacs/jcs-elpa) License ------- From 2974a92f72bc3ac275235f77a15cdcd5a260b60e Mon Sep 17 00:00:00 2001 From: JenChieh Date: Tue, 18 Feb 2025 22:58:55 -0800 Subject: [PATCH 2/5] add eask inst --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dd4d569..184845c 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,9 @@ GitHub repository. * A GitHub account, and a GitHub respository that you have a write-permission and can change `Settings` -* [Cask](https://github.com/cask/cask) or [Eask](https://github.com/emacs-eask/cli) +* [Cask][] or [Eask][] -### 1. Prepare Cask/Eask File +### 1. Prepare Cask File Put `Cask` file to the root of the GitHub repository. Typically it should look like: @@ -74,14 +74,24 @@ Once you put your recipe files, it is time to build your repository! Issue following commands: - cask install # Need only once - cask exec github-elpa update - git push +```sh +cask install # Need only once +cask exec github-elpa update +git push +``` The second command will fetch packages described in `recipes/`, build archives into `docs/elpa`, and git-commit them. +In Eask: + +```sh +eask install-deps # Need only once +eask exec github-elpa update +git push +``` + ### 3. Change Repository Setting After you push `docs/` directory, you need to change the GitHub @@ -176,3 +186,9 @@ License ------- This software is unlicensed. See `LICENSE` for details. + + + + +[Cask]: https://github.com/cask/cask +[Eask]: https://github.com/emacs-eask/cli From 6fdccc1de92c12255fef5649bf98228e200e28a1 Mon Sep 17 00:00:00 2001 From: JenChieh Date: Tue, 18 Feb 2025 23:00:19 -0800 Subject: [PATCH 3/5] add JCS-ELPA badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 184845c..0853179 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![MELPA](http://melpa.org/packages/github-elpa-badge.svg)](http://melpa.org/#/github-elpa) [![MELPA Stable](http://stable.melpa.org/packages/github-elpa-badge.svg)](http://stable.melpa.org/#/github-elpa) +[![JCS-ELPA](https://raw.githubusercontent.com/jcs-emacs/badges/master/elpa/v/github-elpa.svg)](https://jcs-emacs.github.io/jcs-elpa/#/github-elpa) github-elpa =========== From d136a643552888b9d9ba74c1b4d4bc945b1a030e Mon Sep 17 00:00:00 2001 From: JenChieh Date: Tue, 18 Feb 2025 23:03:11 -0800 Subject: [PATCH 4/5] add missing instruction --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0853179..526a333 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ so by just pushing it to GitHub you can publish the repository with GitHub Pages. Setting up a repository and updating packages are really easy. -Once you add a [`Cask`](https://github.com/cask/cask) file and package +Once you add a [`Cask`][Cask]/[`Eask`][Eask] file and package recipes in [MELPA's format](https://github.com/melpa/melpa#recipe-format), issue just one simple command to update the ELPA repository. @@ -34,7 +34,7 @@ GitHub repository. write-permission and can change `Settings` * [Cask][] or [Eask][] -### 1. Prepare Cask File +### 1. Prepare Cask/Eask File Put `Cask` file to the root of the GitHub repository. Typically it should look like: @@ -135,8 +135,17 @@ following to your `init.el`: When package upstreams are updated, you can receive the changes in the same way as first building the repository: - cask exec github-elpa update - git push +```sh +cask exec github-elpa update +git push +``` + +In Eask: + +```sh +eask exec github-elpa update +git push +``` Command-Line Arguments From f7215b3f268c8c347c0c0b54de6bcfd7ebd57374 Mon Sep 17 00:00:00 2001 From: Jen-Chieh Shen Date: Thu, 20 Feb 2025 10:46:41 -0800 Subject: [PATCH 5/5] Remove example --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 526a333..3f19c3e 100644 --- a/README.md +++ b/README.md @@ -187,11 +187,6 @@ This command will git-commit files in `docs/elpa/` (or the directory | `-t, --tar ` | (Use value from `package-build.el`) | Specify tar executable name to archive files | -Example -------- - -- [JCS-ELPA](https://github.com/jcs-emacs/jcs-elpa) - License -------