

INTRO :
=======
	The homepage is http://www.freehackers.org/kvim/
	The core is build around the official vim-6.0 release, and will be
	updated to more recent version when available.

	KVim CVS is now full and does not need extra package. That's actually the 
	reason why we moved to a new CVS server. There we have much more place to
	host KVim. (Thanks TuxFamily for that ;p)

    Note that kvim doesn't work with anti-aliased fonts (and I don't know
    why). Disable anti-alias font to use it (set the environment var 
    QT_XFT=0 ).


INSTALL :
=========
	We now use Vim's configure to configure, compile and install KVim.

	Don't forget, that you need to have QT and KDE headers and tools installed, otherwise it won't
	work ! (these can commonly be found in kde-devel/qt-devel packages)
	
=> Easy/Quick Way :
	In common configurations, you already have a vim >6.0 installed, shipped with your
	OS. So you may not want to overwrite your Vim with this one. If you are in this case,
	then use the script 'installkvim.sh' provided in this directory. It will ask you for some 
	required settings, then configure Vim the proper way, compile and install it without breaking
	your current vim installation.
=> Full Vim install :
	You can use the script to do this, just answer 'n' when it asks whether you have vim installed or not.

=> Advanced :
	Enter the 'vim' directory and configure it your way (you need to add at least these flags to the configure 
	command line : --enable-gui=kde --with-qt-dir=$QTDIR ) then make and make install as root.
	We added to configure some options for KDE / QT detection, it will for example, find whether you use
	KDE 2.x or KDE 3.x automatically. For now, QT is _not_ autodetected. I hope to fix this soon. 
	If you want to specify a specific VIMRUNTIME dir , then run make with the following syntax :
	'make VIMRUNTIMEDIR=your_runtime_dir', read INSTALL.txt in the vim directory for more information.

=> If it fails : (yes it still can, the configure script i wrote is still experimental and probably not 
perfect ;p)
	or 'how to make a bug report' :

	In some cases, I can imagine it will fail, if this happens then send to marchand@kde.org : 
		->auto/config.mk (important one)
		->your configure command line with your options
		->your paths : where KDE is (which version ?), where QT is (version ?), and find where your
			libs are (your kdelibs, your QT libs and QT headers)
		->the output of 'kde-config --version'
		->your OS / Linux Distribution version
		->in case of a compilation error : the full error output.
		->any stuff you think could be usefull to me :)

	Thanks for giving KVim a try, we hope you'll enjoy it !	


How to install the Vim Component
================================
This is quite easy, enter the vimpart directory and then enter the directory for your kde version.
Once there, enter the vimpart directory and run ./testVim your_vim_executable_path, this script will check
if your vim is enough recent to support embedding. If the test fail, then you should try with kvim, it will work.
When the test is successfull, go back to the previous directory and run the configure, make, make install as normal. (install as root). Then run konqui and click on a text file :)
This is still quite experimental and some bugs exists (like the bad size on startup). We are working on this.



How to have the toolbar
=======================
	NOTE: If you used the provided script to install KVim, then you should not need to do the following.

	To have the toolbar and more dialog boxes, find the file menu.vim (usually installed
	in /usr/local/share/vim/ or /usr/share/vim) and apply the following patch:
	(hint : "rpm -ql vim | grep menu.vim or dpkg -S menu.vim", if you don't know where to find the file)
	This patch is for Vim >= 6.0 menu.vim files. For Vim <6.0, the menu.vim are differents !

@@ -152,7 +152,7 @@
 endif
 amenu <silent> 20.400 &Edit.&Select\ all<Tab>ggVG	:if &slm != ""<Bar>exe ":norm gggH<C-O>G"<Bar>else<Bar>exe ":norm ggVG"<Bar>endif<CR>
 amenu 20.405 &Edit.-SEP2-			:
-if has("win32")  || has("win16") || has("gui_gtk") || has("gui_motif")
+if has("win32")  || has("win16") || has("gui_gtk") || has("gui_motif") || has("gui_kde")
   amenu 20.410 &Edit.&Find\.\.\.		:promptfind<CR>
   vunmenu      &Edit.&Find\.\.\.
   vmenu	       &Edit.&Find\.\.\.		y:promptfind <C-R>"<CR>
@@ -334,7 +334,7 @@
   endif
   unlet s:n
 endif
-if has("win32") || has("win16") || has("gui_gtk") || has("gui_photon")
+if has("win32") || has("win16") || has("gui_gtk") || has("gui_photon") || has("gui_kde")
   amenu 20.470 &Edit.Select\ Fo&nt\.\.\.	:set guifont=*<CR>
 endif

CALL FOR TIPS OF THE DAY:
=========================
As you may have seen, KVim has a 'Tip of the day' dialog box :)
We need Tips to fill in this box !
If you write any send them to us so that we can include them in the package :)
Note : you can start kvim with -notip or -tip command line options to disable or enable 
the dialog

DEVELOPMENT STATE AND KNOWN BUGS:
=================================
Port is of course not finished. You won't be able to use kvim with hebrew or
asiatic languages for probably a long time as we don't support multibyte
characters yet. But apart from that, kvim is perfectly usable. The few bugs
are not really annoying.

We would be happy to hear from you if you've tried kvim. Tell us
what is missing, what you like and don't like, and what you want.

As people have wished it for a while, Philippe developped a compononent for Vim.
This should be available on CVS soon and released with KVim 6.0 (=0.2 ;p).

There are some current known bugs which we will fix for KVim 6.1 :
->some fonts indicated as fixed-width by KDE/QT does not appear to work at all
->not perfect resize of kvim (the bottom and right bar)
->the component sometimes starts out of the embedding application
->the component is not resized on startup
There is no need to report these bugs anymore :o) , we know them and are investigating
to debug them.

Next version : KVim 6.1 is under development, it already works and should be soon in CVS :)

SOURCE ACCESS:
==============
Releases and maybe snapshots are/will be found on http://freehackers.org/kvim/
For CVS, we recently moved _out_ from KDE's CVS (due to a space problem, full KVim CVS is 15 Mb), 
The new CVS is CVSROOT=:pserver:anonymous@cvs.tuxfamily.org:/cvsroot/kvim
(with no password)
You'll find there a full vim 6.x package (with runtime files included). 

MAILING LIST:
=============
As we release KVim 0.2 (Vim 6.0), we created a public mailing list, for feedback,
user help and development related discussions : "kvim-dev@freenux.org",
 to subscribe send a mail to "kvim-dev-subscribe@freenux.org" with
"subscribe" as the subject and just reply to the mail you will receive.

THANKS :
========
To all the guys on #kde@opn (Neil, Malte and many other) and to all the people who 
tried, debugged, compiled and recompiled again KVim to bring now a much more robust KVim 
and of course to all of you who send patchs and comments :)
And of course to Vim Authors :)

AUTHORS :
=========
	Thomas Capricelli <orzel@kde.org>
	Philippe Fremy <pfremy@chez.com>
	
CONTRIBUTORS :
==============
	David Spencer Tyree <celer@scrypt.net>
	Mickael Marchand <marchand@kde.org>


