Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mrkkrp committed Sep 6, 2015
0 parents commit 8163ef0
Show file tree
Hide file tree
Showing 5 changed files with 130 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
@@ -0,0 +1,3 @@
*-autoloads.el
*.elc
*~
35 changes: 35 additions & 0 deletions .travis.yml
@@ -0,0 +1,35 @@
env:
matrix:
- EMACS=emacs24
- EMACS=emacs-snapshot

matrix:
allow_failures:
- env: EMACS=emacs-snapshot

before_install:
- git submodule --quiet update --init --recursive

install:
- if [ "$EMACS" = 'emacs24' ]; then
sudo add-apt-repository -y ppa:cassou/emacs &&
sudo apt-get -qq update &&
sudo apt-get -qq -f install &&
sudo apt-get -qq install emacs24 emacs24-el;
fi
- if [ "$EMACS" = 'emacs-snapshot' ]; then
sudo add-apt-repository -y ppa:ubuntu-elisp/ppa &&
sudo apt-get -qq update &&
sudo apt-get -qq -f install &&
sudo apt-get -qq install emacs-snapshot &&
sudo apt-get -qq install emacs-snapshot-el;
fi
- curl -fsSkL https://raw.github.com/cask/cask/master/go | python
- export PATH="/home/travis/.cask/bin:$PATH"
- cask install

script:
- cask build

notifications:
email: false
4 changes: 4 additions & 0 deletions Cask
@@ -0,0 +1,4 @@
(source gnu)
(source melpa)

(package-file "vimish-fold.el")
40 changes: 40 additions & 0 deletions README.md
@@ -0,0 +1,40 @@
# Vimish Fold

*Work in progress.*

[![License GPL 3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.txt)

This is package to do text folding like in Vim. It has the following
features:

* it works on regions you select;

* it's persistent: when you close file your folds don't disappear;

* it's obvious which parts of text are folded;

* it doesn't break anything.

## Installation

If you would like to install the package manually, download or clone it and
put on Emacs' `load-path`, then you can require it in your init file like
this:

```emacs-lisp
(require 'vimish-fold)
```

## Usage

Coming soon…

## Customization

Coming soon…

## License

Copyright © 2015 Mark Karpov

Distributed under GNU GPL, version 3.
48 changes: 48 additions & 0 deletions vimish-fold.el
@@ -0,0 +1,48 @@
;;; vimish-fold.el --- Fold text like in Vim -*- lexical-binding: t; -*-
;;
;; Copyright © 2015 Mark Karpov <markkarpov@openmailbox.org>
;;
;; Author: Mark Karpov <markkarpov@openmailbox.org>
;; URL: https://github.com/mrkkrp/vimish-fold
;; Version: 0.1.0
;; Package-Requires: ((emacs "24.4") (cl-lib "0.5") (f "0.18.0"))
;; Keywords: convenience
;;
;; This file is not part of GNU Emacs.
;;
;; This program is free software: you can redistribute it and/or modify it
;; under the terms of the GNU General Public License as published by the
;; Free Software Foundation, either version 3 of the License, or (at your
;; option) any later version.
;;
;; This program is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
;; Public License for more details.
;;
;; You should have received a copy of the GNU General Public License along
;; with this program. If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This is package to do text folding like in Vim. It has the following
;; features:
;;
;; * it works on regions you select;
;;
;; * it's persistent: when you close file your folds don't disappear;
;;
;; * it's obvious which parts of text are folded;
;;
;; * it doesn't break anything.

;;; Code:

(require 'cl-lib)
(require 'f)

;; TODO write the package here

(provide 'vimish-fold)

;;; vimish-fold.el ends here

0 comments on commit 8163ef0

Please sign in to comment.