Differential D3785 Diff 9280 app_templates/cpp/CMake/cmake_kdevplugin/README

Changeset View

Standalone View

app_templates/cpp/CMake/cmake_kdevplugin/README

This file was added.

1		Simple KDevelop Plugin
	kfunkUnsubmitted Done Turn into a README.md (Markdown syntax) maybe? Way more common these days. kfunk: Turn into a README.md (Markdown syntax) maybe? Way more common these days.
2		----------------------
3
4		-- Installation instructions --
5
6		Make sure the project is configured to install to the directory of your choice:
7
8		In KDevelop, select the menu entry "Project" > "Open Configuration...",
9		then in the dialog choose the tab "CMake",
10		there select in the "Cache Values" list the entry with the name "CMAKE_INSTALL_PREFIX"
11		and ensure the correct path is set.
12
13		If you install to a custom directory, you need to extend the QT_PLUGIN_PATH
14		environment variable that KDevelop sees when it is started. The path to be added
15		is the "plugins" subdir, whose exact path depends on the operating system and
16		if it is 64bit or 32bit.
17		On Debian, Ubuntu & similar add on a 64bit system:
	nalvarezUnsubmitted Not Done add → and? nalvarez: add → and?
	kossebauAuthorUnsubmitted Not Done It really should be "add", but as you can see by the update the double "on" also confused me on second read, so had changed to: "on OS with xx bit system add". Does that work better? kossebau: It really should be "add", but as you can see by the update the double "on" also confused me on…
18		$my_install_prefix/lib/x86_64-linux-gnu/plugins
19		On openSUSE & similar add on a 64bit system:
20		$my_install_prefix/lib64/plugins
21		(where $my_install_prefix is the directory CMAKE_INSTALL_PREFIX is set to)
22
23		If you are unsure, check in the installation log the path to which the plugin is installed.
	kfunkUnsubmitted Not Done "... check the output of `make install` to see where the plugin is installed" maybe? kfunk: "... check the output of `make install` to see where the plugin is installed" maybe?
	kossebauAuthorUnsubmitted Not Done This was written with building from KDevelop UI ;) So `make install` might be too console-centric? kossebau: This was written with building from KDevelop UI ;) So `make install` might be too console…
24
25
26		Example:
27		When CMAKE_INSTALL_PREFIX is set to "/home/userX/projects/mykdevplugin/" and
28		this is a Debian 64-bit system, open a console and enter:
29
30		export QT_PLUGIN_PATH=$QT_PLUGIN_PATH:/home/userX/projects/mykdevplugin/lib/x86_64-linux-gnu/plugins
31
32		Then start KDevelop from that console:
33		kdevelop
34
35		If everything went well, you should see "Hello world, my plugin is loaded!" printed in the console and it also listed in the dialog opened by the menu entry "Help" > "Loaded Plugins".
	nalvarezUnsubmitted Done "and it also listed in" doesn't seem to make grammatical sense. How about "you should see ... printed in the console and the plugin listed in the dialog..."? nalvarez: "and it also listed in" doesn't seem to make grammatical sense. How about "you should see ...
	kossebauAuthorUnsubmitted Not Done As you can see by my update I did while you were commenting on the initial version, I agree :) kossebau: As you can see by my update I did while you were commenting on the initial version, I agree :)