Permalink
Browse files

Added a readme

  • Loading branch information...
1 parent 839c387 commit 4f8367f143b35fd04ad6fdfc55d0ce3e35bb40df myfreeweb committed Aug 18, 2010
Showing with 22 additions and 2 deletions.
  1. +20 −0 README.md
  2. +2 −2 startproject.el
View
@@ -0,0 +1,20 @@
+# startproject #
+Simplest Emacs project starter for all you framework guys — Django, Sproutcore, whatever — they have start commands. Really, the name „startproject“ is from Django‘s script.
+
+Requires a modern Emacs and ido. ido usually works out of the box, at least with GNU Emacs from Ubuntu repos and Aquamacs for Mac.
+
+## How to use it ##
+- require it in your init file (.emacs, config.el, or something else if you‘re very creative)
+
+ `(add-to-list 'load-path "~/Dropbox/emacs/startproject")
+ (require 'startproject)`
+- bind „start-project“ to some key (I don‘t think you want to M-x all the time), like this:
+
+ `(global-set-key (kbd "C-x p") start-project)`
+- add your own starters if you need them, for example:
+
+ `(puthash "html5" "tar -xvf ~/Dropbox/webdev/html5boilerplate.tar.gz" project-starters)`
+- change the work directory — I‘m not sure if you want your projects in ~/:
+
+ `(setq projects-dir "~/Dropbox/work")`
+- enjoy it! Also, follow me on Twitter: [english](http://twitter.com/myfreeweb_en) or [russian](http://twitter.com/myfreeweb).
View
@@ -20,11 +20,11 @@
;;; Commentary:
-;;
+;; Simple project starter. See README.md for more info.
;;; Code:
-(defvar projects-dir "/home/myfreeweb/Dropbox/work/")
+(defvar projects-dir "~/")
(defvar project-starters
(make-hash-table :test 'equal))

0 comments on commit 4f8367f

Please sign in to comment.