Update readme to fit new features

README.md

@@ -1,31 +1,20 @@
 # juCi++
 ###### a lightweight C++-IDE with support for C++11 and C++14.
 ## About
-juCi++ is a lightweight C++-IDE written in C++. You can write plugins
+A lot of IDEs struggle with good C++11/14 support. Therefore we
-in Python and configure the IDE from the config.json file.
+created juCi++. juCi++ is based of the compiler and will *always*
-
+support new versions of C++.
-
+
-## Autocompletion
+## Features
-The IDE supports autocompletion on accessor specifiers such as dot and arrow. The autocompletion has excellent support for C++11/14.
+* Syntax highlighing (even C++11/14)
-
+* Superfast autocomletion (even external libraries)
-## Syntax Highlighting
+* Accurate refactoring across files
-The IDE also supports syntax highligthing even in C++11 and C++14.
+* Basic editor functionallity
-
+* Highlighting of similar types
-## To get C++11 and C++14 support
+* write your own plugins in python (limited atm)
-If you want support for external libraries and C++11 and C++14 you need to make sure you add a parameter to the cmake command. This will make compile_commands.json wich tells juCi++ all the paramters for the compiler. There is a bug where juCi++ sometimes puts the compile_commands.json file in the incorrect folder. Please make sure this file exists and that the contents of it covers all your files.
-```sh
-$ cmake . -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-```
-
-## Plugins
-There are expansion oppertunities with usage of python plugins.
-
-## Configuration
-Configuration description will arrive shortly after source code is added.
 
 ## Dependencies ##
 Please install these dependencies on your system.
-
 * libboost-python-dev 
 * libboost-filesystem-dev 
 * libboost-log-dev 
@@ -43,6 +32,11 @@ Please install these dependencies on your system.
 * clang or gcc (compiler)
 
 ## Installation ##
-See [installation guide](http://github.com/cppit/jucipp/blob/master/docs/install.md).
+Quickstart:
-
+```sh
+$ cmake .
+$ make
+$ sudo make install
+```
+See [installation guide](http://github.com/cppit/jucipp/blob/master/docs/install.md) for more details.
 

docs/install.md

@@ -1,27 +1,22 @@
 # juCi++
 ## Installation guide ##
-## Linux
+Before installation, please install libclangmm see [installation guide](http://github.com/cppit/libclangmm/blob/master/docs/install.md) for installation.
+## Debian
+First dependencies:
 ```sh
-# Libraries (missing libclangmm, see [installation guide](http://github.com/cppit/libclangmm/blob/master/docs/install.md) for installation)
 $ sudo apt-get install libboost-python-dev libboost-filesystem-dev libboost-log-dev libboost-test-dev 
 libboost-thread-dev libboost-system-dev libgtkmm-3.0-dev libgtksourceview2.0-dev libgtksourceviewmm-3.0-dev
-libpython-dev libclang-dev
+libpython-dev libclang-dev make cmake gcc
-# Programs
-$sudo apt-get install make cmake gcc
-
 ```
-Compile
+Install the project:
 ```sh
-# When git clone
+$ git clone http://github.com/cppit/jucipp.git juci
-$ cd path-to-cloned-from-folder/jucipp/juci
+$ cd juci
-# When download zipped file, extraxt it to a folder of your choice
-$ cd path-to-folder-extraxted-into/jucipp-master/juci
-# In both cases above you can choose remove the jucipp folder, but remeber to apply changes to cd command as well.
 $ cmake .
 $ make
+$ sudo make install
 ```
-
 ## Run
 ```sh
-$ ./bin/juci
+$ juci
 ```