Skip to content
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rv-vmartins committed Jul 22, 2016
1 parent 9912339 commit 5faf906
Showing 1 changed file with 83 additions and 11 deletions.
94 changes: 83 additions & 11 deletions README.md
@@ -1,19 +1,59 @@
# vim-frontend
Vim Frontend is a .vimrc configured for Front-end Developer.
Vim Frontend: a .vimrc configured for Front-end Developers.
===========================================================

## Pre-requisites
- [Installation](#installation)
- [Mac OS X](#mac-os-x)
- [Linux x64](#linux-x64)
- [Quick Feature Summary](#quick-feature-summary)

It has been tested with VIM >= 7.2 :exclamation:
Installation
------------

So, if yours is not, good luck :yum: :thumbsup:
### Mac OSX
### Mac OS X

*Pre-requisite*:
```
$ brew install git ctags
```
**Just replace your .vimrc :shipit:**

### Linux
cd ~
git clone https://github.com/VictorVoid/vim-frontend.git .
vim

or

Download ZIP
cd /Users/yourusername/Download
unzip vim-frontend-master.zip
cp vim-frontend-master/.vimrc ~/

*YouCompleteMe Plugin INFO:* :ear:

**Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the ycm_core library APIs have changed (happens
rarely), YCM will notify you to recompile it. You should then rerun the install
process.

Don't worry, it's easy :smile: Let's go.

Install [Homebrew](http://brew.sh/)

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install cmake via Homebrew

brew install cmake

Compiling YCM **with** semantic support for C-family languages:

cd ~/.vim/bundle/YouCompleteMe
./install.py --clang-completer

[More info](https://github.com/Valloric/YouCompleteMe)

### Linux x64
*Pre-requisite*:
* Ubuntu\Debian

```
Expand All @@ -35,15 +75,47 @@ $ sudo pacman -S git-core ctags ncurses python-jinja
$ sudo dnf install ncurses-devel git ctags-etags
```

## Instalation
- Replace your .vimrc
**Just replace your .vimrc :shipit:**

cd ~
git clone https://github.com/VictorVoid/vim-frontend.git .
vim

or

Download ZIP
cd /Users/yourusername/Download
sudo apt-get install unzip
unzip file.zip -d
cp vim-frontend-master/.vimrc ~/


*YouCompleteMe Plugin INFO:* :ear:

**Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the ycm_core library APIs have changed (happens
rarely), YCM will notify you to recompile it. You should then rerun the install
process.

Install development tools and CMake: `sudo apt-get install build-essential cmake`

Make sure you have Python headers installed: `sudo apt-get install python-dev
python3-dev`.

Compiling YCM **with** semantic support for C-family languages:

cd ~/.vim/bundle/YouCompleteMe
./install.py --clang-completer

[More info](https://github.com/Valloric/YouCompleteMe)

## Features
Quick Feature Summary
-----

- Syntax highlighting :white_check_mark:
- JavaScript autocomplete ([ternjs](http://ternjs.net/)) :white_check_mark:
- ES6 Snippets :white_check_mark:
- Html with auto close tag :white_check_mark:
- HTML with auto close tag :white_check_mark:
- Git Support :white_check_mark:
- Emmet :white_check_mark:
- TagBar (overview of its structure) :white_check_mark:
Expand Down

0 comments on commit 5faf906

Please sign in to comment.