|
1 | | -## How to install |
| 1 | +# julia-vim |
2 | 2 |
|
3 | | -### Using [pathogen] |
| 3 | +<p align="center"><img src="logo.png" alt="julia-vim logo"/></p> |
4 | 4 |
|
5 | | -``` bash |
6 | | -cd ~/.vim |
7 | | -mkdir -p bundle && cd bundle |
8 | | -git clone git://github.com/JuliaEditorSupport/julia-vim.git |
9 | | -``` |
10 | | - |
11 | | -### Using [vundle] |
12 | | - |
13 | | -Add a new plugin line to your `.vimrc`: |
14 | | - |
15 | | -``` vim |
16 | | -Plugin 'JuliaEditorSupport/julia-vim' |
17 | | -``` |
18 | | - |
19 | | -Run `vim` and update your bundles: |
| 5 | +[Julia] support for Vim. |
20 | 6 |
|
21 | | -``` vim |
22 | | -:PluginInstall! |
23 | | -``` |
24 | | - |
25 | | -### Using [vim-plug] |
26 | | - |
27 | | -Add a new plugin line to your `.vimrc`: |
28 | | - |
29 | | -``` vim |
30 | | -Plug 'JuliaEditorSupport/julia-vim' |
31 | | -``` |
| 7 | +**[INSTALLATION INSTRUCTIONS]** |
32 | 8 |
|
33 | | -**Note:** do *not* use the on-demand loading feature of vim-plug. |
34 | | -Most of the plugin is loaded on-demand anyway. |
35 | | - |
36 | | -Run `vim` and update your bundles: |
37 | | - |
38 | | -``` vim |
39 | | -:PlugInstall |
40 | | -``` |
41 | | - |
42 | | -[pathogen]: https://github.com/tpope/vim-pathogen |
43 | | -[vundle]: https://github.com/gmarik/vundle |
44 | | -[vim-plug]: https://github.com/junegunn/vim-plug |
45 | | - |
46 | | -### Manually |
47 | | - |
48 | | -Copy (or symlink) the contents of this repository into the vim application support directory: |
49 | | - |
50 | | -``` bash |
51 | | -git clone git://github.com/JuliaEditorSupport/julia-vim.git |
52 | | -cd julia-vim |
53 | | -mkdir -p ~/.vim |
54 | | -cp -R * ~/.vim |
55 | | -``` |
56 | | - |
57 | | -Julia should appear as a file type and be automatically detected for files with the `.jl` extension. |
| 9 | +[Julia]: http://julialang.org/ |
| 10 | +[Installation instructions]: INSTALL.md |
58 | 11 |
|
59 | 12 | ## Complete documentation |
60 | 13 |
|
61 | | -The full documentation is available from Vim. Vundle and other plugin managers will generate the required |
62 | | -help tags automatically, so that you just need to type `:help julia-vim`. Otherwise use `:help helptags` |
63 | | -in ViM and see how to generate them. |
| 14 | +The full documentation is available from Vim: after installation, you just need to type `:help julia-vim`. |
| 15 | + |
| 16 | +The remainder of this README will only give an overview of some of the features: |
64 | 17 |
|
65 | | -The remainder of this README will only give an overview of some of the features. |
| 18 | +* [Latex-to-Unicode substitutions](#latex-to-unicode-substitutions) |
| 19 | +* [Block-wise movements and block text-objects](#block-wise-movements-and-block-text-objects) |
| 20 | +* [Changing syntax highlighting depending on the Julia version](#changing-syntax-highlighting-depending-on-the-julia-version) |
66 | 21 |
|
67 | 22 | ## LaTeX-to-Unicode substitutions |
68 | 23 |
|
|
0 commit comments