diff --git a/README.md b/README.md index d884f5fc54..57d0400d2f 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,20 @@ This software is licensed under the term of the [GNU Lesser General Public Licen ## Continuous Integration Status [![Build status](https://ci.appveyor.com/api/projects/status/vq2o9pfi97isxm2a/branch/master?svg=true)](https://ci.appveyor.com/project/jkriege2/jkqtplotter/branch/master) -## Examples -There is a large set of usage examples (with explanations for each) and tutorials in the folder [`./examples/`](./examples). +## [Examples](./examples/) +There is a [large set of usage examples (with explanations for each) and tutorials](./examples/) in the folder [`./examples/`](./examples). All test-projects are Qt-projects that use qmake to build. You can load them into QtCreator easily. -[EXAMPLES-Page](./examples/) [![EXAMPLES-Page](./screenshots/examplesbanner.png)](./examples/) -## Screenshots +## [Screenshots](./screenshots/) +The [Screenshots-page](./screenshots/) contains several screenshots, partly taken from the provided examples, but also from other software using this libarary (e.g. [QuickFit 3.0](https://github.com/jkriege2/QuickFit3)) + [![EXAMPLES-Page](./screenshots/screenshotsbanner.png)](./screenshots/) -[SCREENSHOTS-Page](./screenshots/) + ## Building Building instructions can be found here: - include necessary files into QMake project: [`./lib/*.pri`](./lib) -- build a static library: [`./staticlib/*.pro`](./staticlib) -- build a shared library (DLL): [`./sharedlib/*.pro`](./sharedlib) +- [build a static library](./staticlib): [`./staticlib/*.pro`](./staticlib) +- [build a shared library (DLL, SO, ...)](./sharedlib): [`./sharedlib/*.pro`](./sharedlib)