/README

http://github.com/yoshiki/yaml-mode · #! · 65 lines · 48 code · 17 blank · 0 comment · 0 complexity · 7abeb4096ece1a3ce5fb453cb3dc0404 MD5 · raw file 

    

  1. RECRUITMENTS
    2. 

  2.     I have not used emacs and this library for a long time,
    3. 

  3.     so I recruit maintainers or collaborators for all yaml-mode users.
    4. 

  4.     If you are interested in maintaining or collaborating with this library,
    5. 

  5.     please contact me.
    6. 

  6. 

  7. NAME
    8. 

  8.     yaml-mode - Simple major mode to edit YAML file for emacs
    9. 

  9. 

  10. REQUIREMENTS
    11. 

  11.     Emacs 24.1
    12. 

  12. 

  13. SYNOPSIS
    14. 

  14.     To install, just drop this file into a directory in your
    15. 

  15.     `load-path' and (optionally) byte-compile it.  To automatically
    16. 

  16.     handle files ending in '.yml', add something like:
    17. 

    18. 

  18.     (require 'yaml-mode)
    19. 

  19.     (add-to-list 'auto-mode-alist '("\\.yml\\'" . yaml-mode))
    20. 

    21. 

  21.     to your .emacs file.
    22. 

    23. 

  23.     Unlike python-mode, this mode follows the Emacs convention of not
    24. 

  24.     binding the ENTER key to `newline-and-indent'.  To get this
    25. 

  25.     behavior, add the key definition to `yaml-mode-hook':
    26. 

    27. 

  27.     (add-hook 'yaml-mode-hook
    28. 

  28.       '(lambda ()
    29. 

  29.         (define-key yaml-mode-map "\C-m" 'newline-and-indent)))
    30. 

    31. 

  31. DESCRIPTION
    32. 

  32.     yaml-mode is major mode for emacs.
    33. 

    34. 

  34. INSTALL
    35. 

  35.     You can install yaml-mode typing below.
    36. 

    37. 

  37.         % make
    38. 

  38.         % make install
    39. 

    40. 

  40.         or
    41. 

    42. 

  42.         % make PREFIX=/your/home/dir
    43. 

  43.         % make install PREFIX=/your/home/dir
    44. 

    45. 

  45. SETTING
    46. 

  46.     see SYNOPSIS.
    47. 

    48. 

  48. AUTHOR
    49. 

  49.     Yoshiki Kurihara <kurihara@cpan.org> Copyright (C) 2010 by Free Software
    50. 

  50.     Foundation, Inc.
    51. 

    52. 

  52.     This file is free software; you can redistribute it and/or modify it
    53. 

  53.     under the terms of the GNU General Public License as published by the
    54. 

  54.     Free Software Foundation; either version 2, or (at your option) any
    55. 

  55.     later version.
    56. 

    57. 

  57.     This file is distributed in the hope that it will be useful, but WITHOUT
    58. 

  58.     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    59. 

  59.     FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
    60. 

  60.     more details.
    61. 

    62. 

  62.     You should have received a copy of the GNU General Public License along
    63. 

  63.     with GNU Emacs; see the file COPYING. If not, write to the Free Software
    64. 

  64.     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
    65. 

  65.     USA.
    66.