branch: main
commit 7ee57f0391e9f64e138d2db914e0e61e5f4fd95b
Author: Stephen Leake <stephen_le...@stephe-leake.org>
Commit: Stephen Leake <stephen_le...@stephe-leake.org>
* README (Getting the source): Add setup, move checkout packages here
---
README | 52 ++++++++++++++++++++++++++++++----------------------
1 file changed, 30 insertions(+), 22 deletions(-)
diff --git a/README b/README
index d6114a8..9e77d6c 100644
--- a/README
+++ b/README
@@ -23,6 +23,36 @@ for testing purposes).
Start with source that is cloned directly from Savannah. See
[[https://savannah.gnu.org/git/?group=emacs][the Savannah page]]
and look for "ELPA". Using a clone of a clone does not work.
+You must then do some setup:
+#+begin_src shell
+ make setup
+#+end_src
+
+That leaves the =packages= directory empty; you must check out the
+ones you want.
+
+If you wish to check out all the packages into the =packages=
+directory, you can run the command:
+
+#+begin_src shell
+ make worktrees
+#+end_src
+
+You can check out a specific package =<pkgname>= into the =packages=
+directory with this command:
+
+#+begin_src
+ make packages/<pkgname>
+#+end_src
+
+If you already have a =packages/<pkgname>= directory with a previous
+checkout, you can update it like this:
+
+#+begin_src
+ cd packages/PACKAGE
+ git pull
+#+end_src
+
* Directory layout
** =admin/= -- scripts for administering the package archive.
@@ -221,28 +251,6 @@ and push that change to the master branch of =elpa=.
After it's added to
the =elpa-packages= file, the package can be maintained just by
pushing changes to the =externals/<pkgname>= branch.
-If you wish to check out all the packages into the =packages=
-directory, you can run the command:
-
-#+begin_src shell
- make worktrees
-#+end_src
-
-You can check out a specific package =<pkgname>= into the =packages=
-directory with these commands:
-
-#+begin_src
- make packages/<pkgname>
-#+end_src
-
-If you already have a =packages/<pkgname>= directory with a previous
-checkout, you can update it like this:
-
-#+begin_src
- cd packages/PACKAGE
- git pull
-#+end_src
-
** Public incubation
If you want to develop a package publicly prior to its first release (to
