Skip to content

hacking

Yue-Lan edited this page Jun 1, 2020 · 1 revision

Hacking

Documents and Examples

Before you have a hacking, I strongly recommend you look the documentions and examples through.

Use doxygen to generate an docs index is better, just as I said in README.

Example will help you get started quickly for libpeony. If you have any good idea about libpeony's usage, initiate a pull request

Contributing directly

Sence Peony refectored by Qt, It has been almost 1 year. But there are many places meet some problems. Peony is still unstable, and you can help us to reduce the bugs and adding the new features if you are confident about yourself. The contributions of a open sources project is essential, and may be full of twists and turns, but i belive every contribution will make this project better.

You'd better look again Contribution Manual. As the maintainer of Peony, I have to restrict and avoid the unhealth growing of the project. I hope the contributor contribute the codes not only considering the advantice that the modifications bring to us, but also considering the potaintial risk which might occur in a holistic perspective.

Based on libpeony

Peony is based on libpeony, but that not means it can only used by Peony. You can do a development based on libpeony, too.

Peony extensions

You can see I have written some plugins for peony. The most instersting plugin is computer view, which providing a special view for computer:///. Open in terminal, compress files, and share folders are all plugins, too.

It is not difficult to develop a extension by yourself if you known the Qt's plugin frameworks. Just use your imagination to try.

A new file manager application

If you are not satisfied with the current UI interface and want to customize the UI yourself, you can do a second development based on libpeony. the most frameworks and fucions intergrated in Peony can reused, so you do not have to rewrite them again.

Last but not least

Whatever you write a new file manager application based on libpeony, or write a peony-extension, it is your freedom. But you should remember that you have to respect the license and copyright, I don't want to see what happens to the peony project due to opening up and a lesser public license.