Skip to content

Commit

Permalink
doc: improve quick start text
Browse files Browse the repository at this point in the history
refer: #1946
  • Loading branch information
lervag committed May 23, 2021
1 parent d14aa66 commit 368f145
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ filetype and syntax plugin for LaTeX files.
- [Requirements](#requirements)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Screenshots](#screenshots)
- [Features](#features)
- [Other relevant plugins](#other-relevant-plugins)
- [Linting and syntax checking](#linting-and-syntax-checking)
Expand Down Expand Up @@ -68,10 +69,12 @@ If you use the new package feature in Vim, please note the following:

## Quick Start

The following is a simple guide for how to use VimTeX. It only displays the
most basic features. Users are _strongly_ encouraged to read or at least skim
through the documentation to learn about the different features and
possibilities provided by VimTeX (see [`:h vimtex`](doc/vimtex.txt)).
The following is a video guide for how to use VimTeX (credits: @DustyTopology;
https://github.com/lervag/vimtex/issues/1946#issuecomment-846345095). It
displays some of the main features. Users are of course _strongly_ encouraged
to read the documentation, at least the introduction, to learn about the
different features and possibilities provided by VimTeX (see [`:h
vimtex`](doc/vimtex.txt)).

https://user-images.githubusercontent.com/66584581/119213849-1b7d4080-ba77-11eb-8a31-7ff7b9a4a020.mp4

Expand All @@ -81,9 +84,12 @@ supplementary documents:
* [CONTRIBUTING.md](CONTRIBUTING.md)
* [DOCUMENTATION.md](DOCUMENTATION.md)

## Screenshots

Here is an example of the syntax highlighting provided by VimTeX. The example
is made with the [vim-colors-xcode](https://github.com/arzg/vim-colors-xcode)
colorscheme with some minor adjustments [described
is made by @DustyTopology with the
[vim-colors-xcode](https://github.com/arzg/vim-colors-xcode) colorscheme with
some minor adjustments [described
here](https://github.com/lervag/vimtex/issues/1946#issuecomment-843674951).

![Syntax example](https://github.com/lervag/vimtex-media/blob/main/img/syntax.png)
Expand Down

0 comments on commit 368f145

Please sign in to comment.