Skip to content

Commit

Permalink
Added installation instructions to README and a link to the youtube
Browse files Browse the repository at this point in the history
trailer.

Signed-off-by: Christian Rapp <[email protected]>
  • Loading branch information
crapp committed Nov 2, 2015
1 parent 4846efb commit 87fee76
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,4 @@ install_manifest.txt
build
CMakeLists.txt.user
doc/html
package
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

qAccordion provides an accordion widget for Qt 5. The widget is heavily inspired by the [jQuery UI accordion control](https://jqueryui.com/accordion/).

__Please note this library is still in an early development stage.__
Watch a screencast made with the [Demo Application](#demo-application) to see what qAccordion is.

[![qAccordion Demo Screencast](http://i.imgur.com/vLz2dYk.png)](https://www.youtube.com/watch?v=czhRcNdSHw4 "qAccordion Demo Screencast")

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand All @@ -22,13 +24,36 @@ __Please note this library is still in an early development stage.__

## Setting up qAccordion

qAccordion is based on Qt5 and c++11. Make sure your development environment meets this requirements.
qAccordion is based on Qt5 and c++11. Make sure your development environment meets this requirements.

To make use of this Qt Widget in your Project you have two choices.

1. Use the included CMake project files to compile a shared library which you link to your application.
2. Add the source code of the library to your project and compile it. Make sure to include the icons qrc file

## Installation

Obtain the source from the [github repository](https://github.com/crapp/qaccordion). Either download the latest release or check out the latest commit.

Run the following commands to compile a shared library on Linux.

```shell
# create a build directory
mkdir build
cd build
# run cmake to create make files
cmake -DCMAKE_BUILD_TYPE=Release ../
# now compile the source code and create the shared library. you can speed up compilation with the j option.
make
# install the shared library
sudo make install

```

There are ready to use packages for the following Linux distributions:

* Archlinux (AUR)

## Usage

Using this widget is quite easy. You can add this to your application either programmatically or by using Qt Designer. The widget does __not__ support configuration via the Designer.
Expand Down Expand Up @@ -85,6 +110,7 @@ Have a look at the source code of the demo application if you are searching for
If you find a Bug or have a feature request head over to github and open a new [issue](https://github.com/crapp/qaccordion/issues).

## ToDo ##
* Drag and Drop support. The API already supports moving Content Panes but only programmatically.
* Maybe much, maybe nothing. So far it covers all my use cases ;)

## FAQ ##
Expand All @@ -109,4 +135,4 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
```
```

0 comments on commit 87fee76

Please sign in to comment.