Emacs config utilizing prelude as a base
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

87 lines
2.8 KiB

14 years ago
14 years ago
14 years ago
14 years ago
14 years ago
14 years ago
14 years ago
14 years ago
  1. ```
  2. ____ _ _
  3. | _ \ _ __ ___| |_ _ __| | ___
  4. | |_) | '__/ _ \ | | | |/ _` |/ _ \
  5. | __/| | | __/ | |_| | (_| | __/
  6. |_| |_| \___|_|\__,_|\__,_|\___|
  7. ```
  8. Emacs is probably the best text editor in the world. However, the
  9. process of coming up with a useful Emacs configuration is long and
  10. difficult. It's this process that separates you from truly taking
  11. advantage of Emacs's power. I like to refer to this process as the
  12. **Prelude**. **Prelude** has the goal to ease the initial Emacs setup
  13. process and to provide you with a much more powerful and productive
  14. experience than that you get out of the box. By using **Prelude**
  15. you're basically getting a "Get me out of the Prelude, I just want to
  16. use Emacs" card.
  17. **Prelude** is compatible **ONLY with GNU Emacs 24**. While Emacs 24
  18. is not yet officially released it's a rock solid piece of software
  19. more than suitable for everyday work. There is no good excuse not to
  20. use Emacs 24!
  21. ## Fast Forward
  22. Assuming you're using an Unix-like OS (`*BSD`, `GNU/Linux`, `OS X`, `Solaris`,
  23. etc), you already have Emacs 24 installed, as well as `git` & `curl` you
  24. can skip the whole manual and just type in your favorite shell the
  25. following command:
  26. `curl -L
  27. https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
  28. | sh`
  29. You can now power up your Emacs, sit back and enjoy Prelude.
  30. There are two environment variables you can use to control the
  31. source repository and the installation directory. To change the
  32. installation directory:
  33. `PRELUDE_INSTALL_DIR="$HOME/.emacs.d" &&
  34. curl -L
  35. https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
  36. | sh`
  37. To change the source repository:
  38. `PRELUDE_URL="https://github.com/yourname/prelude.git" &&
  39. curl -L
  40. https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
  41. | sh`
  42. ## Would you like to know more?
  43. Check out the [Prelude's project page](http://batsov.com/prelude) for
  44. all the gory details.
  45. If you're looking for more info on Emacs in general - consult
  46. [WikEmacs](http://wikemacs.org).
  47. ## More goodies
  48. The [Prelude Modules](https://github.com/bbatsov/prelude-modules)
  49. project contains a lot of additional packages for Prelude
  50. (install-able via the `package-list-packages` command) - enhanced programming
  51. mode configs, latex config, erc config, etc.
  52. ## Known issues
  53. Check out the project's
  54. [issue list](https://github.com/bbatsov/prelude/issues?sort=created&direction=desc&state=open)
  55. a list of unresolved issues. By the way - feel free to fix any of them
  56. and sent me a pull request. :-)
  57. ## Contributors
  58. Here's a [list](https://github.com/bbatsov/prelude/contributors) of all the people who have contributed to the
  59. development of Emacs Prelude.
  60. ## Bugs & Improvements
  61. Bug reports and suggestions for improvements are always
  62. welcome. GitHub pull requests are even better! :-)
  63. Cheers,<br>
  64. Bozhidar