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.

88 lines
2.9 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
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 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**.
  18. ## Fast Forward
  19. Assuming you're using an Unix-like OS (`*BSD`, `GNU/Linux`, `OS X`, `Solaris`,
  20. etc), you already have Emacs 24 installed, as well as `git` & `curl` you
  21. can skip the whole manual and just type in your favorite shell the
  22. following command:
  23. `curl -L
  24. https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
  25. | sh`
  26. You can now power up your Emacs, sit back and enjoy Prelude.
  27. There are two environment variables you can use to control the
  28. source repository and the installation directory. To change the
  29. installation directory:
  30. `PRELUDE_INSTALL_DIR="$HOME/.emacs.d" &&
  31. curl -L
  32. https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
  33. | sh`
  34. To change the source repository:
  35. `PRELUDE_URL="https://github.com/yourname/prelude.git" &&
  36. curl -L
  37. https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
  38. | sh`
  39. Note that the installer will back up any existing `.emacs` file or
  40. `.emacs.d` since it will unpack Prelude's code in `.emacs.d`. If
  41. you're doing a manual install make sure you don't have a `.emacs` file
  42. or back up your existing `.emacs.d` directory manually.
  43. ## Would you like to know more?
  44. Check out the [Prelude's project page](http://batsov.com/prelude) for
  45. all the gory details.
  46. If you're looking for more info on Emacs in general - consult
  47. [WikEmacs](http://wikemacs.org).
  48. ## More goodies
  49. The [Prelude Modules](https://github.com/bbatsov/prelude-modules)
  50. project contains a lot of additional packages for Prelude
  51. (install-able via the `package-list-packages` command) - enhanced programming
  52. mode configs, latex config, erc config, etc.
  53. ## Known issues
  54. Check out the project's
  55. [issue list](https://github.com/bbatsov/prelude/issues?sort=created&direction=desc&state=open)
  56. a list of unresolved issues. By the way - feel free to fix any of them
  57. and sent me a pull request. :-)
  58. ## Contributors
  59. Here's a [list](https://github.com/bbatsov/prelude/contributors) of all the people who have contributed to the
  60. development of Emacs Prelude.
  61. ## Bugs & Improvements
  62. Bug reports and suggestions for improvements are always
  63. welcome. GitHub pull requests are even better! :-)
  64. Cheers,<br>
  65. Bozhidar