Skip to content

Commit

Permalink
Merge pull request #47 from ryantm/doc
Browse files Browse the repository at this point in the history
add --names argument to README
  • Loading branch information
ttuegel committed Dec 31, 2018
2 parents 6325b86 + ce8236f commit 752fe1b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,18 @@ before building this package!

The scripts `elpa-packages.sh`, `org-packages.sh`, `melpa-packages.sh`, and
`melpa-stable-packages.sh` regenerate each package set. They require
Nix to build.
Nix to build.

To update the ELPA or org-mode packages, run
```.bash
# For ELPA packages
./elpa-packages.sh \
-o $NIXPKGS/pkgs/applications/editors/emacs-modes/elpa-generated.nix
-o $NIXPKGS/pkgs/applications/editors/emacs-modes/elpa-generated.nix \
--names names.nix
# For org-mode packages
./org-packages.sh \
-o $NIXPKGS/pkgs/applications/editors/emacs-modes/org-generated.nix
-o $NIXPKGS/pkgs/applications/editors/emacs-modes/org-generated.nix \
--names names.nix
```
`$NIXPKGS` should be the path to the Nixpkgs clone which you are updating.

Expand All @@ -28,7 +30,8 @@ To update the MELPA packages, run
# Use melpa-stable-packages.sh to update melpa-stable-generated.nix instead
./melpa-packages.sh \
--melpa $MELPA \
-o $NIXPKGS/pkgs/applications/editors/emacs-modes/melpa-generated.nix
-o $NIXPKGS/pkgs/applications/editors/emacs-modes/melpa-generated.nix \
--names names.nix
```
`$MELPA` should be tho path to a clone of the [MELPA](https://github.com/milkypostman/melpa)
repository.
Expand Down

0 comments on commit 752fe1b

Please sign in to comment.