Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Mention v2 in readme.

  • Loading branch information...
commit 55fb2cbb73aa4e605f09a487e11462db2019f025 1 parent f2a3699
Phil Hagelberg technomancy authored
Showing with 26 additions and 11 deletions.
  1. +26 −11 README.markdown
37 README.markdown
View
@@ -47,6 +47,23 @@ Note that having a ~/.emacs file might override the starter kit
loading, so if you've having trouble loading it, make sure that file
is not present.
+## Future
+
+Work is in progress on
+[version 2 of the Starter Kit](https://github.com/technomancy/emacs-starter-kit/tree/v2),
+which is structured as a set of packages rather than a git repository
+you use wholesale as your dotfiles. This allows for greater
+modularity: support for each language may be installed separately, and
+once package.el becomes more widespread it should make installation
+much easier.
+
+Version 2 is not quite ready for general consumption, though
+adventurous users are welcome to try it. Note that it requires Emacs
+version 24, which is still in development.
+
+If you have ideas for improvements to the Starter Kit, please base
+them on the v2 branch.
+
## Structure
The init.el file is where everything begins. It's the first file to
@@ -94,22 +111,20 @@ it's difficult to test in it, and breakage is common.
## Contributing
+Please see the note re: "Future" above; active development is only
+happening on the "v2" branch.
+
If you know your way around Emacs, please try out the starter kit as a
replacement for your regular dotfiles for a while. If there's anything
you just can't live without, add it or let me know so I can add
it. Take a look at what happens in init.el to get started.
-Also: see the file TODO. Helping submit new libraries to Marmalade is the
-easiest way to help out. There are two ways you can do this: either
-take new libraries and make them ready for Marmalade, dropping them in the
-elpa-to-submit directory or take files that are already in
-elpa-to-submit, ensuring all their dependencies are correctly loaded
-into Marmalade, and uploading them. Grep the project for TODO for other things.
+Also: Helping submit new libraries to Marmalade is the easiest way to
+help out. This involves ensuring the library's dependencies are all
+already packaged and then adding the appropriate package headers and
+autoload comments. It's best to contact the package maintainer to ask
+them if they mind having their software distributed on Marmalade. It's
+also ideal to push your autoload/header changes back upstream.
Files are licensed under the same license as Emacs unless otherwise
specified. See the file COPYING for details.
-
-The latest version is at http://github.com/technomancy/emacs-starter-kit/
-
-On Unix, /home/$USER/.emacs.d, on windows Documents and Settings/%your
-user name%/Application Data
Please sign in to comment.
Something went wrong with that request. Please try again.