From 3e317b7338bf5b3503ff421c008f6d55b170b4f1 Mon Sep 17 00:00:00 2001 From: VG Date: Thu, 24 Nov 2016 17:50:27 +0100 Subject: add mit license --- README.rst | 52 ----------------------------------------- license.txt | 21 +++++++++++++++++ readme.rst | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 98 insertions(+), 52 deletions(-) delete mode 100644 README.rst create mode 100644 license.txt create mode 100644 readme.rst diff --git a/README.rst b/README.rst deleted file mode 100644 index 5aefb7b..0000000 --- a/README.rst +++ /dev/null @@ -1,52 +0,0 @@ -vim-uuid-anchor -############### - -Installation with vundle -======================== - -Just put ``Bundle 'git://git.devys.org/vim-uuid-anchor'`` in your -*~/.vim/vimrc*. - -Manual Installation -=================== - -1. Clone the git repository:: - - git clone git://git.devys.org/vim-uuid-anchor - cd vim-uuid-anchor - -3. Copy the file ``ftplugin/uuid_anchor.vim`` to your ``~/.vim/ftplugin`` - directory - -Usage -===== - -Table of content to real content example: - -1. Place yourself at the line of the item you want to be jumpable:: - - 1. item 1 - 2. item 2 <-- You want to add a description while keeping this list - simple. Place your cursor here. - 3. item 3 - -2. Place yourself in insert mode at the end of line, add a space and call the - uuid function, with default vim configuration, press ``A ``, then - ``,,uuid`` (assuming your leader is ','):: - - 1. item 1 - 2. item 2 DCE564FB - 3. item 3 - -3. Elsewhere in the text file, at the description's place in our example, - you can paste the last generated uuid by pressing ``"up``:: - - DCE564FB: - Description with lots of text lines of the item 2. - Another line of description. - Last line of description. - -4. Later, when you want to jump from the item list to the description, or jump - back, simply place your cursor on the uuid and press ``*`` or ``#``. - -5. Be pleased by your new plugin and possibilities. diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..648eeb8 --- /dev/null +++ b/license.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright © 2016 vg + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/readme.rst b/readme.rst new file mode 100644 index 0000000..f843bb0 --- /dev/null +++ b/readme.rst @@ -0,0 +1,77 @@ +vim-uuid-anchor +############### + +Description +=========== + +Generate UUID anchors to jump from place to place in text files + +Installation with vundle +======================== + +Just put ``Bundle 'git://git.devys.org/vim-uuid-anchor'`` in your +*~/.vim/vimrc*. + +Manual Installation +=================== + +1. Clone the git repository:: + + git clone git://git.devys.org/vim-uuid-anchor + cd vim-uuid-anchor + +3. Copy the file ``ftplugin/uuid_anchor.vim`` to your ``~/.vim/ftplugin`` + directory + +Usage +===== + +Table of content to real content example: + +1. Place yourself at the line of the item you want to be jumpable:: + + 1. item 1 + 2. item 2 <-- You want to add a description while keeping this list + simple. Place your cursor here. + 3. item 3 + +2. Place yourself in insert mode at the end of line, add a space and call the + uuid function, with default vim configuration, press ``A ``, then + ``,,uuid`` (assuming your leader is ','):: + + 1. item 1 + 2. item 2 DCE564FB + 3. item 3 + +3. Elsewhere in the text file, at the description's place in our example, + you can paste the last generated uuid by pressing ``"up``:: + + DCE564FB: + Description with lots of text lines of the item 2. + Another line of description. + Last line of description. + +4. Later, when you want to jump from the item list to the description, or jump + back, simply place your cursor on the uuid and press ``*`` or ``#``. + +5. Be pleased by your new plugin and possibilities. + +License +======= + +Unless specified otherwise, this project is licensed under the terms of the +MIT license. You should have received a copy of the MIT License along with +this program. If not, see . + +SPDX-License-Identifier: MIT + +Copyright © 2016 vg + +Contact +======= + +developer + vg + +mail + vg@devys.org -- cgit v1.2.3