Skip to content

Commit 68cf190

Browse files
committed
Rework part of README file.
1 parent f2ee980 commit 68cf190

File tree

1 file changed

+30
-28
lines changed

1 file changed

+30
-28
lines changed

README.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
## Example view
2525
![](exampleScreen.gif?raw=true "")
2626

27-
## Description
27+
## About project
2828
Volbx is a graphical tool used for data manipulation written in C++/Qt. User can:
2929
* load data - opens XLSX and ODS spreadsheet files,
3030
* filter data - filters panel can be used to define data range on each column,
@@ -33,35 +33,37 @@ Volbx is a graphical tool used for data manipulation written in C++/Qt. User can
3333
* order data - each column can be ordered ascending or descending,
3434
* export data - selected set of data, together with linked plots, can be exported to XLSX spreadsheet file or CSV.
3535

36-
## History
3736
The tool was originally created for real estate appraisal as it gives the possibility, for people working in that area, to estimate past, current and future value of analyzed properties. When project/start-up was dropped, I've decided to release a less specialized application as an open source project. Most advanced and dedicated for real estates functionalities were cut out, basic and intermediate ones stayed.
3837

39-
## Used tools and libs
40-
| Tool | Windows | Lubuntu |
41-
| --- | --- | --- |
42-
| OS version | 10 22H2 | 22.04 |
43-
| GCC | 11.2.0 | 11.3.0 |
44-
| CMake | 3.25.0 | 3.25.0 |
45-
| Git | 2.38.1 | 2.34.1 |
46-
| Qt | 6.5.2 | 6.5.2 |
47-
| Qt Creator | 10.0.2 | 10.0.2 |
48-
| Qwt | 6.2 | 6.2 |
49-
| QuaZip | 1.4 | 1.4 |
50-
| Zlib | 1.3.1 | 1.3.1 |
51-
| Eible | 1.2.0 | 1.2.0 |
52-
| QwtBle | 1.2.0 | 1.2.0 |
53-
| Wble | 1.2.0 | 1.2.0 |
54-
55-
## Compilation and installation
56-
Use directly CMake or Qt Creator. CMake **should**:
57-
- configure everything automatically,
58-
- download dependencies using Git (QuaZip, Zlib, Eible, Wble, Qwtble, Qwt),
59-
- build dependencies,
60-
- compile Volbx and create binaries.
61-
62-
This is of course a happy path...
63-
64-
**TIPS**: set `CMAKE_PREFIX_PATH` env variable (should point to Qt) and add `qmake` location to `PATH` variable (QWT building expects it).
38+
## Getting Started
39+
This section describes briefly how to setup the environment and build the project.
40+
41+
### Prerequisites
42+
Qt in version 6.5 or greater, a C++ compiler with C++17 support as a minimum, and CMake 3.16+.
43+
44+
### Building
45+
Clone and use CMake directly or via any IDE supporting it. CMake should:
46+
- configure everything automatically,
47+
- compile and create binaries.
48+
49+
As a result of compilation, binary for simulations and binary for testing should be created.
50+
51+
**TIP**: Remember to set properly the `CMAKE_PREFIX_PATH` env variable. It should have a Qt installation path to let CMake `find_package` command work.
52+
53+
**TIP**: Add `qmake` location to `PATH` variable as QWT building expects it.
54+
55+
## Built with
56+
57+
| | Windows | Windows | Ubuntu |
58+
| --- | --- | --- | --- |
59+
| OS version | 10 22H2 | 10 22H2 | 24.04 |
60+
| compiler | GCC 13.1.0 | MSVC 19.29 | GCC 13.2.0 |
61+
| CMake | 3.30.2 | 3.30.2 |3.28.3 |
62+
| Git | 2.46.0 | 2.46.0 | 2.43.0 |
63+
| Qt | 6.5.2 | 6.5.2 | 6.5.2 |
64+
| Eible | 1.2.0 | 1.2.0 | 1.2.0 |
65+
| QwtBle | 1.2.0 | 1.2.0 | 1.2.0 |
66+
| Wble | 1.2.0 | 1.2.0 | 1.2.0 |
6567

6668
## Licensing
6769
Volbx is published using LGPLv3 license.

0 commit comments

Comments
 (0)