README.md 2.85 KB
Newer Older
1
Emacs Powerpack README -- Currell Berry -- 03/31/2018
2 3
=================================================

Currell Berry's avatar
Currell Berry committed
4 5 6 7 8 9
Emacs Powerpack is an Emacs installer for Windows.  It takes care of creating a
start menu entry, creating a right click "open with" dropdown, add/remove programs 
in the registry, etc.  It also comes with a default configuration which enables
good interopability with msys2, which can be separately installed frim msys2.org.
The goal of emacs powerpack is to make it as easy as possible to set up a 
productive emacs-based unix-like development environment on a windows computer.
10

11
Download v0.92
Currell Berry's avatar
Currell Berry committed
12
-------------------------------------------------------------------
13 14 15

NOTE: file hosting for the project is now on sourceforge, at https://sourceforge.net/projects/emacs-powerpack .

16
[Download v0.92](https://sourceforge.net/projects/emacs-powerpack/files/Emacs_PowerPack_v0.92.exe/download)
17

Currell Berry's avatar
Currell Berry committed
18 19
What Emacs Powerpack Does
-------------------------------------------------------------------
Currell Berry's avatar
Currell Berry committed
20
Once Emacs Powerpack and Msys2 are installed, several things should be accomplished for you:
21

Currell Berry's avatar
Currell Berry committed
22
1. You can type "emacs" in the start menu to find and launch emacs.
Currell Berry's avatar
Currell Berry committed
23 24 25
2. Context menus should have an "open with emacs" option.
3. You have an easy choice of integrating emacs with windows cmd shell or msys2 shell
4. Features like M-x grep and M-x shell should work
Currell Berry's avatar
Currell Berry committed
26 27 28 29

Installation Directions
---------------------------------------------------------------------

Currell Berry's avatar
Currell Berry committed
30 31 32 33 34 35 36 37
1. (optional but recommended) First install msys2 from http://www.msys2.org/ to get a good unix-like shell installed on your system.

2. Then download emacs powerpack and run the installer.
    
Uninstallation
---------------------------------------------------------------------

Use Add/Remove Programs feature in Windows.
38

Currell Berry's avatar
Currell Berry committed
39 40 41 42 43 44

Notes
---------------------------------------------------------------------
In certain edge cases, you may have to restart windows before changes to PATH take effect.

Note that if "open with emacs" ever stops working it's probably because the .emacs.d/server/server file has gotten out of date (windows uses tcp to manage emacsclient connections, this is less robust than the method used on unix/linux.).  I have seen this occur when the computer crashes with emacs still running.  Delete the server file and try again.
45

46 47 48 49 50
Build Instructions
----------------------------------------------------------------------
- Check out project
- Download latest version of emacs for Windows as a zip file.  Make new folder named externals inside the project root and place the emacs zip there.
- Download nsis2 and install that
Currell Berry's avatar
Currell Berry committed
51
- Move the included nsisunz.dll into the Plugins folder of your nsis2 installation (we require this nsis plugin to extract the emacs zip at installation time)
52 53
- Right click on installer3.nsi in windows explorer, and select "Compile NSIS Script"
- NSIS should run and produce you a working Emacs_Powerpack.exe isntaller of your own