Skip to content

Commit

Permalink
Merge 'bbatsov/master'
Browse files Browse the repository at this point in the history
* 'bbatsov/master' of ..: (151 commits)
  [Fix bbatsov#1345] Replace packages gitconfig-mode and gitignore-mode with git-modes (bbatsov#1346)
  Enable proced on Darwin too
  Add my Liberapay profile
  Add a module for F# programming (bbatsov#1334)
  Replace yank-pop key binding with counsel-yank-pop (bbatsov#1331)
  Change link to stackoveflow tag to emacs-prelude
  Fix diminishing company-mode
  Auto-install racket-mode if needed
  Update the changelog
  Tweak a bit the new modules
  [Fix bbatsov#1320] Remove company-lsp
  Add Racket module (bbatsov#1321)
  Lua module documentation
  Add Lua programming support
  Fix a couple of typos (bbatsov#1319)
  Bind all essential avy commands
  Release Prelude 1.1
  Use display-line-numbers for Emacs 26.1 and later
  [Fix bbatsov#1308] Remove ivy-prescient
  Ignore lsp-generated files
  Add var/ to gitignore
  [Docs] Add a note
  Improve some keybindings
  Use lsp-workspace-restart
  Ensure ivy-prescient is loaded after counsel
  Tweak a couple of comments
  Don't force the projectile-completion-system
  Add prelude-selectrum module
  Add ivy-prescient to prelude-ivy
  Fix auto-mode-alist REGEXP for org-mode
  Orgmode package is called 'org' and not 'org-mode'
  In org-mode buffers, bind C-a to org-beginning-of-line
  Remove legacy folder themes
  Tweak the org-mode config a bit
  Document the vendor folder
  Clean up the modeline a bit
  [Docs] Mention editorconfig-mode
  Add a changelog entry
  Don't auto-insert coding comments in Ruby
  Fix a changelog entry
  Add a note about prelude-evil
  Enable a few more modules by default
  Fix a typo
  Update prelude-rust.el
  Prefix init messages coming from Prelude so they are easier to spot
  Fix auto-mode-alist setup for adoc-mode
  Fallback to the sample prelude-modules.el if missing
  [Docs] Fix a typo
  Remove a file committed by mistake
  Move some config where it belongs
  [Docs] Improve the listing of essential packages
  [Docs] Fix some broken formatting
  [Docs] Tweak the ERC docs
  [Docs] Update the mkdocs config to include the new pages
  [Docs] Document the Scheme module
  [Docs] Tweak the CL module
  Add some modules documentation
  Reorder the changelog a bit
  Auto-install julia-mode
  Improve the WSL check
  Extend the FAQ
  Add mappings AsciiDoc file extensions
  Tweak some changelog entries
  Add extra configuration for WSL and Windows
  Improve the documentation for prelude-python
  Touch up the previous commit
  Add prelude-python-mode-set-encoding-automatically defcustom (bbatsov#1293)
  Add transient/ to .gitignore (bbatsov#1286)
  Use EOS instead of EOL for auto mode regexp
  Improve the sample module configuration
  Recognize more Clojure extensions
  Auto-install adoc-mode
  Fix a couple of tips
  Fix indentation
  Use crux-kill-line-backwards
  Fix a duplicated keybinding
  Tweak the ivy module
  [Docs] Reorder a bit the installation sections
  Touch up the last commit
  Document site-wide installation of Prelude
  User Specific save files
  Disable the scheme module in the sample module config
  Add the ag package
  Remove beacon-mode
  Restructure a bit the sample modules files
  [Docs] Fix a typo
  [Docs] Tweak some markup
  [Docs] Improve the installation instructions
  Add more links to the docs from the README
  [Docs] Extend the installation docs
  Remove prelude-fullscreen
  [Docs] Extend the landing page
  Update the prelude-core description
  Remove prelude-ensure-module-deps alias
  Update required Emacs version check
  Tweak the PR template
  [Fix bbatsov#1266] Improve Emacs version detection logic in the installer script
  Document prelude-super-keybindings
  Document prelude-minimalistic-ui
  Tweak a bit init.el
  ...
  • Loading branch information
suutari committed Jan 8, 2022
2 parents feaecc9 + c52889d commit 957a620
Show file tree
Hide file tree
Showing 90 changed files with 1,594 additions and 457 deletions.
7 changes: 7 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# These are supported funding model platforms

github: bbatsov
ko_fi: bbatsov
patreon: bbatsov
liberapay: bbatsov
custom: https://www.paypal.me/bbatsov
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug Report
about: Report an issue with Emacs Prelude you've discovered.
---

*Use the template below when reporting bugs. Please, make sure that
you're running the latest Emacs Prelude and that the problem you're reporting
hasn't been reported (and potentially fixed) already.*

**Remove all of the placeholder text in your final report!**

## Expected behavior

## Actual behavior

## Steps to reproduce the problem

*This is extremely important! Providing us with a reliable way to reproduce
a problem will expedite its solution.*

## Environment & Version information

### Emacs version

*E.g. 24.5* (use <kbd>M-x emacs-version</kbd> to check it if unsure)

### Operating system

*E.g. Fedora 23, OS X 10.11 "El Capitan", Windows 10, etc*
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature Request
about: Suggest new Emacs Prelude features or improvements to existing features.
---

**Is your feature request related to a problem? Please describe.**

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**

A clear and concise description of what you want to happen.

**Describe alternatives you've considered**

A clear and concise description of any alternative solutions or features you've considered.

**Additional context**

Add any other context or screenshots about the feature request here.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
**Replace this placeholder text with a summary of the changes in your PR.
The more detailed you are, the better.**

-----------------

Before submitting the PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):

- [ ] The commits are consistent with our [contribution guidelines](../blob/master/CONTRIBUTING.md)
- [ ] You've updated the [changelog](../blob/master/CHANGELOG.md) (if adding/changing user-visible functionality)
- [ ] You've updated the [user manual](../blob/master/doc) (if adding/changing user-visible functionality like modules, commands, configuration options, etc)

Thanks!
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ network-security.data
prelude-cheatsheet.el
prelude-cheatsheet.aux
prelude-cheatsheet.log
transient/
var/
.cache/
.lsp-session*
/indium-workspaces.el
/elpy
/transient
58 changes: 58 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Change log

## master (unreleased)

### New features

* Add a Racket module.
* Add a Lua module.
* Auto-install `racket-mode` if needed.
* Add a F# module.

### Changes

* Bind all essential `avy` commands to their recommended keybindings.
* Remove `company-lsp`.
* Replace `yank-pop` key-binding to `counse-yank-pop` for `ivy-mode`.
* The keybinding for `proced` is now enabled unconditionally.

### Bugs fixed

* Fix `company` still being visible in the mode line.

## 1.1.0 (2021-02-14)

### New features

* Enable `nlinum-mode` or `display-line-numbers-mode` by default. Can be disabled by setting `prelude-minimalistic-ui` to `t`.
* Enable site-wide installation for Prelude.
* Auto-installs `julia-mode` if needed.
* Auto-install `adoc-mode` for AsciiDoc files.
* Add the `ag` package. It provides a nice alternative to `grep` and has nice Projectile integration.
* Added additional configuration modules for WSL (`prelude-wsl`) and Windows (`prelude-windows`).
* Add `prelude-selectrum` module. Selectrum a simpler alternative to `ivy-mode`.

### Changes

* [#1292](https://github.com/bbatsov/prelude/issues/1292): Add `prelude-python-mode-set-encoding-automatically` defcustom inn `prelude-python.el` module with nil default value.
* [#1278](https://github.com/bbatsov/prelude/issues/1278): Don't disable `menu-bar-mode` unless `prelude-minimalistic-ui` is enabled.
* [#1277](https://github.com/bbatsov/prelude/issues/1277): Make it possible to disable the creation of `Super`-based keybindings via `prelude-super-keybindings`.
* Removed deprecated alias `prelude-ensure-module-deps`.
* Remove `prelude-fullscreen`, as these days people can use `toggle-frame-fullscreen` instead. (it was introduced in Emacs 24.4)
* Removed `beacon-mode`.
* Added `transient/` to `.gitignore`.
* Fallback to `sample/prelude-modules.el` in the absence of a `prelude-modules.el` in one's personal folder.
* [Ruby] Don't auto-insert coding comments.
* Hide (via `diminish`) `editorconfig-mode`, `super-save`, `company`, `abbrev` and `ivy` in the modeline.
* Use `lsp-workspace-restart` function instead of deprecated `lsp-restart-workspace`.
* Bind all online search commands under `C-c C-/` to avoid a conflict with `counsel-git` or `magit-file-dispatch`.
* Bound `magit-file-mode` to `C-c g` (it's also bound to `C-c M-g` if you decide to utilize this keybinding for something else.
* Added `.cache/` and `lsp-session*` to `.gitignore`. These are generated by `lsp`.

### Bugs fixed

* [#1302](https://github.com/bbatsov/prelude/issues/1302): `C-a` should be bound to `org-beginning-of-line` in org-mode buffers.

## 1.0.0 (2020-09-15)

Initial "stable" release after 9 years of development.
17 changes: 10 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ try to follow these guidelines when you do so.

## Issue reporting

* Check that the issue has not already been reported.
* Check that the [issue has not already been reported][2].
* Check that the issue has not already been fixed in the latest code
(a.k.a. `master`).
* Be clear, concise and precise in your description of the problem.
Expand All @@ -17,15 +17,18 @@ try to follow these guidelines when you do so.

## Pull requests

* Read [how to properly contribute to open source projects on Github][2].
* Read [how to properly contribute to open source projects on GitHub][3].
* Use a topic branch to easily amend a pull request later, if necessary.
* Write [good commit messages][3].
* Write [good commit messages][4].
* Update the [changelog][5].
* Use the same coding conventions as the rest of the project.
* Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>).
* Open a [pull request][4] that relates to *only* one subject with a clear title
* Open a [pull request][6] that relates to *only* one subject with a clear title
and description in grammatically correct, complete sentences.

[1]: https://github.com/bbatsov/prelude/issues
[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[4]: https://help.github.com/articles/using-pull-requests
[2]: https://github.com/bbatsov/prelude/issues?q=is:issue
[3]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
[4]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[5]: https://github.com/bbatsov/prelude/blob/master/CHANGELOG.md
[6]: https://help.github.com/articles/using-pull-requests
90 changes: 75 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,54 +12,110 @@ configuration for Emacs newcomers and lots of additional power for
Emacs power users.

Prelude is compatible **ONLY with GNU Emacs 25.1+**. In general you're
advised to always run Prelude with the latest Emacs - currently
**26.1**.
advised to always run Prelude with the latest stable Emacs release.

You can support the development of Prelude via
[GitHub Sponsors](https://github.com/sponsors/bbatsov),
[ko-fi](https://ko-fi.com/bbatsov),
[PayPal](https://www.paypal.me/bbatsov) and
[Patreon](https://www.patreon.com/bbatsov).

## Features

* Improved UX, that's still in line with Emacs traditions
* Sane defaults of baseline Emacs functionality
* Automatic installation of many major programming modes on demand
* A curated set of 3rd party packages to enhance the base functionality
* Simple modular architecture
* Easy customization

Check out our [user manual](https://prelude.emacsredux.com) for more information.

## Fast Forward

Assuming you're using an Unix-like OS (`*BSD`, `GNU/Linux`, `macOS`, `Solaris`,
etc), you already have Emacs 24.4+ installed, as well as `git` & `curl` you
etc), you already have a recent version of Emacs installed, as well as `git` & `curl` you
can skip the whole manual and just type in your favorite shell the
following command:

```bash
curl -L https://git.io/epre | sh
```shellsession
$ curl -L https://git.io/epre | sh
```

You can now power up your Emacs, sit back and enjoy Prelude,
forgetting about the rest of this manual.
You can now power up your Emacs, sit back and enjoy Prelude.

There are two environment variables you can use to control the
source repository and the installation directory. To change the
installation directory:

```bash
export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
```shellsession
$ export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
```

To change the source repository:

```bash
export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
```shellsession
$ export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
```

Note that the installer will back up any existing `.emacs` file or
`.emacs.d` since it will unpack Prelude's code in `.emacs.d`. If
you're doing a manual install make sure you don't have a `.emacs` file
or back up your existing `.emacs.d` directory manually.

Don't forget to adjust your `prelude-modules.el` file in your personal directory
**Important:** Don't forget to adjust your `prelude-modules.el` file in your personal directory
once the installation is done. By default most of the modules
that ship with Prelude are not loaded.
that ship with Prelude are **not** loaded.

## Philosophy

Prelude's philosophy is quite simple:

* simple
* easy to understand and extend
* stable
* a foundation for you to build upon, as opposed to some end-user product

This means that it intentionally doesn't pack all the bells and whistles that it could.
Prelude aims to enhance the classic Emacs experience without deviating a lot from it - e.g.
it would never enable something like `evil-mode` (vim keybindings) by default and so on.

All the third-party packages that it bundles are carefully vetted and are known to be of
good quality and to have reliable maintainers. That generally means that Prelude's unlikely
to immediate adopt some shiny new package, that has established tried and true alternatives.

In practice this translates to the following:

* Prelude is less opinionated than distros like Spacemacs and Doom Emacs (meaning it's closer to the standard Emacs experience)
* Prelude installs relatively few additional packages by default
* Most modules in Prelude are opt-in instead of opt-out (you'll notice the default config enables only a handful of modules)
* Most modules (e.g. modules for programming languages) are pretty short and feature setup only for essential packages (in some cases that be just the major mode for the language in question)
* You don't really need to track Prelude's upstream - you're encouraged to just fork it and use it as the basis for your own configuration.

Remember that the ultimate goal of every Emacs user is to create an Emacs setup that reflects their own experience, needs, goals and ideas. Just like Lisp,
Emacs is nothing but a raw building material for the perfect editing experience.

More installation options are discussed [here](https://prelude.emacsredux.com/en/latest/installation/).

## User Manual

While Emacs Prelude is pretty simple at its core, it does have some specifics that
are worth learning - e.g. configuration options, load order of modules and personal settings
and so on.

Check out our [user manual](https://prelude.emacsredux.com) for more information.

You can also find a lot of information about specific Prelude features and the rationale behind them on
my Emacs blog [Emacs Redux](https://emacsredux.com).

## crux and super-save

A lot of utility commands that used to be part of Prelude were eventually extracted to the [crux](https://github.com/bbatsov/crux) package,
so they'd be easily available to more people.
These days Prelude simply depends on that package.

The [super-save](https://github.com/bbatsov/super-save) package also used to be part of Prelude in the past.

## Known issues

Check out the project's
Expand All @@ -85,7 +141,11 @@ development of Emacs Prelude.
Bug reports and suggestions for improvements are always
welcome. GitHub pull requests are even better! :-)

Cheers,<br/>
[Bozhidar](https://twitter.com/bbatsov)
## License

Copyright © 2011-2021 Bozhidar Batsov and
[contributors](https://github.com/bbatsov/prelude/contributors).

Distributed under the GNU General Public License, version 3

[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
Loading

0 comments on commit 957a620

Please sign in to comment.