summaryrefslogtreecommitdiffstats
path: root/doc/cryptol.txt
blob: 0d90528c39448366337f2d278bb105a0ece80245 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'cryptol') == -1

*cryptol.txt* functionality for the Cryptol programming language

Copyright © 2013 Edward O'Callaghan. All Rights Reserved.

  .oooooo.                                       .             oooo  
 d8P'  `Y8b                                    .o8             `888  
888          oooo d8b oooo    ooo oo.ooooo.  .o888oo  .ooooo.   888  
888          `888""8P  `88.  .8'   888' `88b   888   d88' `88b  888  
888           888       `88..8'    888   888   888   888   888  888  
`88b    ooo   888        `888'     888   888   888 . 888   888  888  
 `Y8bood8P'  d888b        .8'      888bod8P'   "888" `Y8bod8P' o888o 
                      .o..P'       888                               
                      `Y8P'       o888o                              

          Functionality for the Cryptol programming language.
        Includes syntax highlighting, code folding, and more!

==============================================================================
CONTENTS                                                      *CryptolContents*

    1. Usage ................ |CryptolUsage|
    2. Mappings ............. |CryptolMappings|
    3. License .............. |CryptolLicense|
    4. Bugs ................. |CryptolBugs|
    5. Contributing ......... |CryptolContributing|
    6. Changelog ............ |CryptolChangelog|
    7. Credits .............. |CryptolCredits|

==============================================================================
Section 1: Usage                                                 *CryptolUsage*

This plugin will automatically provide syntax highlighting for Cryptol files
(files ending in .cry).

Cryptol is a purely functional domain specific language, developed over the
past decade by Galois for the NSA, for the design, implementation and
verification of cryptographic algorithms.

==============================================================================
Section 2: Mappings                                           *CryptolMappings*

Code folding is done in the typical way, for example:
 * za - When on a closed fold - open it.
 * zM - Close all foldings to level 0.
 * zR - Reduce folding

For more information see, for example, :help za

==============================================================================
Section 3: License                                             *CryptolLicense*

Copyright © 2013 Edward O'Callaghan. All Rights Reserved.

HOWEVER:
Be it known, The syntax file was written by
Copyright © 2005 Fergus Henderson. All Rights Reserved.


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.

==============================================================================
Section 4: Bugs                                                   *CryptolBugs*

 * https://github.com/victoredwardocallaghan/cryptol.vim/issues

==============================================================================
Section 5: TODOs                                                *CryptolTODOs

 * Add compiler support
  - .

==============================================================================
Section 6: Contributing                                   *CryptolContributing*

 * Edward O'Callaghan

==============================================================================
Section 7: Changelog                                         *CryptolChangelog*

 * Initial 25 Apr 2013.

==============================================================================
Section 8: Credits                                             *CryptolCredits*

 * Edward O'Callaghan
 * Fergus Henderson - wrote the orginal syntax file.

vim:ts=4:ft=help:tw=78:et

endif