branch: main
commit c955c0944570ebb372e630ecd98e8db42e4b3423
Author: Stefan Monnier <monn...@iro.umontreal.ca>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
* README.org: Fix old names, and mention the initial `make` step
---
.gitignore | 1 +
README.org | 37 +++++++++++++++++++++++++------------
2 files changed, 26 insertions(+), 12 deletions(-)
diff --git a/.gitignore b/.gitignore
index d162373..065973e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
*.elc
+*.tar
*.orig
.dir-locals?.el
*~
diff --git a/README.org b/README.org
index a8263e7..ec40534 100644
--- a/README.org
+++ b/README.org
@@ -1,7 +1,7 @@
#+TITLE: NonGNU ELPA README
#+DATE: 2020-12-21
-Copyright (C) 2020 Free Software Foundation, Inc. \\
+Copyright (C) 2020-2021 Free Software Foundation, Inc. \\
See the end of the file for license conditions.
This repository contains the sources, deployment scripts, and auxiliary files
@@ -12,6 +12,26 @@ This file explains the repository layout, how to add and
edit packages, and how
to deploy the archive (either on =elpa.nongnu.org=, or a local copy for testing
purposes).
+* Initial setup
+
+To do anything with, you first have to have a local clone, which you can get
+with:
+
+#+begin_src sh
+ git clone .../nongnu.git $FOO
+#+end_src
+
+and which you may have done already if you're reading this file.
+The main branch on =nongnu.git= only holds the list of specifications
+of the packages included, but not the scripts to build them.
+So after doing this, you need to do:
+
+#+begin_src sh
+ make
+#+end_src
+
+This will fetch a branch from =elpa.git= containing all the build scripts
+and makefiles and place them where needed.
* Building the archive
@@ -27,13 +47,6 @@ directory. This format is described in the Emacs Lisp
Reference Manual chapter
To build the archive(s), all it takes is:
#+begin_src sh
- git clone .../nongnu.git $FOO
-#+end_src
-
-which you presumably have done already if you're reading this file.
-And then
-
-#+begin_src sh
cd .../nongnu
make build-all
#+end_src
@@ -60,7 +73,7 @@ to do:
The packages can be installed and used in-place. First you need to make
sure the package(s) you can about are placed in the =packages= subdirectory,
-e.g. with =make externals=, and then you can to add that =.../packages=
+e.g. with =make worktrees=, and then you can to add that =.../packages=
to your =package-directory-list=. And once that is done you can do:
#+begin_src sh
@@ -194,7 +207,7 @@ packages with:
Once it is decided we want to add a package =[PKG]=, here's what it takes:
-- Add a corresponding entry to the file =externals-list=, then
+- Add a corresponding entry to the file =elpa-packages=, then
#+begin_src sh
make fetch/<pkgname>
@@ -216,10 +229,10 @@ Once it is decided we want to add a package =[PKG]=,
here's what it takes:
make sync/<pkgname>
#+end_src
-- Commit and push the change to =externals-list=:
+- Commit and push the change to =elpa-packages=:
#+begin_src sh
- git commit -m "* externals-list (<pkgname>): New package" -- externals-list
+ git commit -m "* elpa-packages (<pkgname>): New package" -- elpa-packages
git push
#+end_src
