summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorStephen Leake <stephen_leake@stephe-leake.org>2021-01-11 09:26:18 -0800
committerJonas Bernoulli <jonas@bernoul.li>2021-10-21 00:38:23 +0200
commit3a4ba9969772a290df1cdf5d6abafd77fb691172 (patch)
tree7606687065791aff97c1ad5010552f5bc73e2e25 /README
parentf809ca0f88e7a8381d5d162491b1eb7437daccb4 (diff)
* README (Getting the source): Add setup, move checkout packages here
Diffstat (limited to 'README')
-rw-r--r--README52
1 files changed, 30 insertions, 22 deletions
diff --git a/README b/README
index 55ad7ad..8c71782 100644
--- a/README
+++ b/README
@@ -12,6 +12,36 @@ the [[https://elpa.gnu.org/][GNU ELPA]] and NonGNU ELPA archives.
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
This code expects to be used in a directory that has the following layout:
@@ -391,28 +421,6 @@ and push that change to the default branch of =elpa=. After it's added to
the =elpa-packages= file, the package can be maintained just by
pushing changes to the =elpa/<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