Commit 4adbe91b authored by Jason Blevins's avatar Jason Blevins

Add MELPA badges and update README.md

parent 08a8afeb
Deft for Emacs
==============
# Deft for Emacs [![MELPA badge][melpa-badge]][melpa-link] [![MELPA stable badge][melpa-stable-badge]][melpa-stable-link] [![Travis CI Build Status][travis-badge]][travis-link]
[melpa-link]: https://melpa.org/#/deft
[melpa-stable-link]: https://stable.melpa.org/#/deft
[melpa-badge]: https://melpa.org/packages/deft-badge.svg
[melpa-stable-badge]: https://stable.melpa.org/packages/deft-badge.svg
[travis-link]: https://travis-ci.org/jrblevin/deft
[travis-badge]: https://travis-ci.org/jrblevin/deft.svg?branch=master
<!-- Automatically generated from comments in deft.el. -->
......@@ -10,27 +16,54 @@ notes by making it fast and simple to find the right file at the
right time and by automating many of the usual tasks such as
creating new files and saving files.
![Deft Screencast](http://jblevins.org/projects/deft/deft-v0.6.gif)
Obtaining Deft
--------------
Deft is open source software and may be freely distributed and
modified under the BSD license. Version 0.7 is the latest stable
version, released on December 21, 2015. You may download it
directly here:
modified under the BSD license. The latest stable release is
version 0.7, released on December 21, 2015.
**Installation via MELPA Stable**
The recommended way to install Deft is to obtain the stable version
from [MELPA Stable](https://stable.melpa.org/#/deft) using
`package.el`. First, configure `package.el` and the MELPA Stable
repository by adding the following to your `.emacs`, `init.el`, or
equivalent startup file:
(require 'package)
(add-to-list 'package-archives
'("melpa-stable" . "https://stable.melpa.org/packages/"))
(package-initialize)
Then, after restarting Emacs or evaluating the above statements, issue
the following command: <kbd>M-x package-install RET deft RET</kbd>.
[MELPA Stable]: http://stable.melpa.org/
**Direct Download**
Alternatively you can manually download and install Deft.
First, download the latest stable version of and save the file
where Emacs can find it---a directory in your `load-path`:
* [deft.el](http://jblevins.org/projects/deft/deft.el)
To follow or contribute to Deft development, you can browse or
clone the Git repository at [jblevins.org][] or [GitHub][]:
Then, add the following line to your startup file:
git clone git://jblevins.org/git/deft.git
git clone https://github.com/jrblevin/deft.git
(require 'deft)
[![Build Status][status]][travis]
**Development Version**
[jblevins.org]: http://jblevins.org/git/deft.git
[GitHub]: https://github.com/jrblevin/deft
[travis]: https://travis-ci.org/jrblevin/deft
[status]: https://travis-ci.org/jrblevin/deft.svg?branch=master
To follow or contribute to Deft development, you can browse or
clone the Git repository [on GitHub](https://github.com/jrblevin/deft):
![Deft Screencast](http://jblevins.org/projects/deft/deft-v0.6.gif)
git clone https://github.com/jrblevin/deft.git
Overview
--------
The Deft buffer is simply a file browser which lists the titles of
all text files in the Deft directory followed by short summaries
......@@ -117,12 +150,8 @@ point number given by `deft-auto-save-interval` (default: 1.0).
Getting Started
---------------
To start using it, place it somewhere in your Emacs load-path and
add the line
(require 'deft)
in your `.emacs` file. Then run <kbd>M-x deft</kbd> to start. It is useful
Once you have installed Deft following one of the above methods,
you can simply run <kbd>M-x deft</kbd> to start Deft. It is useful
to create a global keybinding for the `deft` function (e.g., a
function key) to start it quickly (see below for details).
......@@ -185,7 +214,7 @@ The displayed title of each file is taken to be the first line of
the file, with certain characters removed from the beginning. Hash
characters, as used in Markdown headers, and asterisks, as in Org
Mode headers, are removed. Additionally, Org mode `#+TITLE:` tags,
MultiMarkdown `Title:` tags, LaTeX comment markers (<kbd>%</kbd>), and
MultiMarkdown `Title:` tags, LaTeX comment markers, and
Emacs mode-line declarations (e.g., `-*-mode-*-`) are stripped from
displayed titles. This can be customized by changing
`deft-strip-title-regexp`.
......@@ -347,7 +376,7 @@ Version 0.6 (2015-06-26):
* Update default `deft-strip-title-regexp` to remove the following:
- org-mode `#+TITLE:` tags
- MultiMarkdown `Title:` tags
- LaTeX comment markers (i.e., `%`)
- LaTeX comment markers
- Emacs mode-line declarations (e.g., `-*-mode-*-`)
* Remove leading and trailing whitespace from titles.
* Disable visual line mode to prevent lines from wrapping.
......
......@@ -240,7 +240,7 @@
;; the file, with certain characters removed from the beginning. Hash
;; characters, as used in Markdown headers, and asterisks, as in Org
;; Mode headers, are removed. Additionally, Org mode `#+TITLE:` tags,
;; MultiMarkdown `Title:` tags, LaTeX comment markers (`%`), and
;; MultiMarkdown `Title:` tags, LaTeX comment markers, and
;; Emacs mode-line declarations (e.g., `-*-mode-*-`) are stripped from
;; displayed titles. This can be customized by changing
;; `deft-strip-title-regexp'.
......@@ -402,7 +402,7 @@
;; * Update default `deft-strip-title-regexp' to remove the following:
;; - org-mode `#+TITLE:` tags
;; - MultiMarkdown `Title:` tags
;; - LaTeX comment markers (i.e., `%`)
;; - LaTeX comment markers
;; - Emacs mode-line declarations (e.g., `-*-mode-*-`)
;; * Remove leading and trailing whitespace from titles.
;; * Disable visual line mode to prevent lines from wrapping.
......
......@@ -5,8 +5,14 @@ STOPRE='^;;; Code:$'
DATE=$(date +"%B %e, %Y %H:%M %Z")
# Produce README.md for GitHub
echo "Deft for Emacs
==============
echo "# Deft for Emacs [![MELPA badge][melpa-badge]][melpa-link] [![MELPA stable badge][melpa-stable-badge]][melpa-stable-link] [![Travis CI Build Status][travis-badge]][travis-link]
[melpa-link]: https://melpa.org/#/deft
[melpa-stable-link]: https://stable.melpa.org/#/deft
[melpa-badge]: https://melpa.org/packages/deft-badge.svg
[melpa-stable-badge]: https://stable.melpa.org/packages/deft-badge.svg
[travis-link]: https://travis-ci.org/jrblevin/deft
[travis-badge]: https://travis-ci.org/jrblevin/deft.svg?branch=master
<!-- Automatically generated from comments in deft.el. -->" > README.md
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment