Permalink
Browse files

FAQ in readme

  • Loading branch information...
1 parent 8e70adf commit 730dec1d2afbb0d732f2187ad9855c8a03cc6298 myfreeweb committed Aug 18, 2010
Showing with 20 additions and 6 deletions.
  1. +20 −6 README.md
View
26 README.md
@@ -1,7 +1,7 @@
# 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.
+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 :-)
-It just runs framework's **start command** (or just a simple **tar** command extracting your project skeleton) and opens the newly created project with **dired**.
+It just runs frameworks **start command** (or just a simple **tar** command extracting your project skeleton... or a **mkdir** if you‘re not a framework guy) and opens the newly created project with **dired**.
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.
@@ -13,10 +13,24 @@ Requires a modern **Emacs** and **ido**. ido usually works out of the box, *at l
- 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:
+- add your own starters if you need them, for example, [HTML5 Boilerplate](http://html5boilerplate.com):
- `(puthash "html5" "tar -xvf ~/Dropbox/webdev/[html5boilerplate](http://html5boilerplate.com).tar.gz" project-starters)`
-- change the work directory — I‘m not sure if you want your projects in ~/. Don‘t forget the /:
+ `(puthash "html5" "tar -xvf ~/Dropbox/webdev/html5-boilerplate-0.9.x.tar.gz" project-starters)`
+- change the work directory — I‘m not sure if you want your projects in ~/. **Don‘t forget the slashes!**:
`(setq projects-dir "~/Dropbox/work/")`
-- enjoy it! Also, follow me on Twitter: [english](http://twitter.com/myfreeweb_en) or [russian](http://twitter.com/myfreeweb).
+- enjoy it! Also, follow me on Twitter: [english](http://twitter.com/myfreeweb_en) or [russian](http://twitter.com/myfreeweb) and on [Github](http://github.com/myfreeweb).
+
+## FAQ ##
+- Q: It says something about wrong paths... What the?
+
+ A: You forgot slashes in the projects-dir.
+- Q: Why I have to add a command for my favorite framework by hand? It‘s popular.
+
+ A: Because I‘m lazy to google these commands for all the mainstream frameworks. Just [email me](mailto:me@myfreeweb.ru) a command for your thing.
+- Q: Why it requires ido?
+
+ A: Ido is very awesome! I can‘t believe you don‘t have it installed. It **must** come with your Emacs!
+- Q: Why Emacs?
+
+ A: Because vim sucks!

0 comments on commit 730dec1

Please sign in to comment.