3rdparty/QXlsx/README.md

0001 # QXlsx
0002
0003 > *Read this in other languages: [English](README.md), :kr: [Korean](README.ko.md), :ru: [Russian](README.RU.md)*
0004
0005 <p align="center"><img src="https://raw.githubusercontent.com/QtExcel/QXlsx/master/markdown.data/QXlsx-Desktop.png"></p>
0006
0007 - QXlsx is excel file(`*.xlsx`) reader/writer library.
0008   - Because QtXlsx is no longer supported(2014), I created a new project that is based on QtXlsx. (2017-)
0009 - Development language of QXlsx is C++. (with Qt)
0010 - You don't need to use static library or dynamic shared object using QXlsx.
0011   - You can also use it as a static library.
0012
0013 ## How to use
0014 - See [examples](Example.md)
0015 - See [wiki](https://github.com/QtExcel/QXlsx/wiki)
0016 - See [FAQ](https://github.com/QtExcel/QXlsx/wiki/FAQ)
0017
0018 ## How to set up (Installation)
0019
0020 - See [how to setup QXlsx project (qmake)](HowToSetProject.md)
0021 - See [how to setup QXlsx project (cmake)](HowToSetProject-cmake.md)
0022
0023 ## Tested environment
0024
0025 | Travis CI (Linux) | AppVeyor (Windows) | CodeFactor | Github Actions <br> Linux/Win/Mac | iOS / Android  |
0026 | :---------------: | :----------------: | :--------: | :------------------------: | :----------------------------: |
0027 | [![Build Status](https://travis-ci.com/QtExcel/QXlsx.svg?branch=master)](https://travis-ci.com/QtExcel/QXlsx) | [![Build status](https://ci.appveyor.com/api/projects/status/jkod8257gg66vm6e?svg=true)](https://ci.appveyor.com/project/QtExcel/qxlsx) | [![CodeFactor](https://www.codefactor.io/repository/github/qtexcel/qxlsx/badge)](https://www.codefactor.io/repository/github/qtexcel/qxlsx) | [![Ubuntu](https://github.com/QtExcel/QXlsx/workflows/Ubuntu/badge.svg)](https://github.com/QtExcel/QXlsx/actions/Ubuntu)  [![MacOS](https://github.com/QtExcel/QXlsx/workflows/MacOS/badge.svg)](https://github.com/QtExcel/QXlsx/actions/MacOS)  [![Windows](https://github.com/QtExcel/QXlsx/workflows/Windows/badge.svg)](https://github.com/QtExcel/QXlsx/actions/Windows) | [![IOS](https://github.com/QtExcel/QXlsx/workflows/IOS/badge.svg)](https://github.com/QtExcel/QXlsx/actions/IOS)  [![Android](https://github.com/QtExcel/QXlsx/workflows/Android/badge.svg)](https://github.com/QtExcel/QXlsx/actions/Android) |
0028
0029
0030 - See [tested environments](TestEnv.md)
0031
0032 ## To Do
0033 - [To test](ToTest.md)
0034 - [What to upgrade](ToUpgrade.md).
0035 - [Vision](Vision.md)
0036
0037 ## Contributions
0038 - See [contributors](https://github.com/QtExcel/QXlsx/graphs/contributors).
0039
0040 ## License and links
0041 - QXlsx is under MIT license. [https://github.com/QtExcel/QXlsx](https://github.com/QtExcel/QXlsx)
0042 - Thank you for creating the following amazing projects. :+1:
0043   - Qt is under LGPL v3 license or Commercial license. [https://www.qt.io/](https://www.qt.io/)
0044   - QtXlsxWriter is under MIT license. :+1: [https://github.com/dbzhang800/QtXlsxWriter](https://github.com/dbzhang800/QtXlsxWriter)
0045   - Qt-Table-Printer is under BSD 3-Clause license. [https://github.com/T0ny0/Qt-Table-Printer](https://github.com/T0ny0/Qt-Table-Printer)
0046   - recurse is under MIT license. [https://github.com/pkoretic/recurse](https://github.com/pkoretic/recurse)
0047   - libfort is under MIT license. [https://github.com/seleznevae/libfort](https://github.com/seleznevae/libfort)
0048   - colorprintf is under MIT license. [https://github.com/VittGam/colorprintf](https://github.com/VittGam/colorprintf)
0049   - HelloActions-Qt is under MIT license. [https://github.com/jaredtao/HelloActions-Qt](https://github.com/jaredtao/HelloActions-Qt)
0050
0051 ## :email: Contact
0052 - Leave me a issue. [https://github.com/QtExcel/QXlsx/issues](https://github.com/QtExcel/QXlsx/issues)
0053         - If you are interested in participating in the project, please contact us by issue.
0054         - My native language is not English and my English is not fluent. Please, use EASY English. :-)
0055 - If you would like to translate README.md into your native language, please contact me.
0056         - You can either raise an issue or use a pull request. (such as README.ko.md)
0057
0058 ## Similar projects
0059
0060 ### :star: <b>Qxlnt</b> [https://github.com/QtExcel/Qxlnt](https://github.com/QtExcel/Qxlnt)
0061
0062 <p align="center"><img src="https://github.com/QtExcel/Qxlnt/raw/master/markdown-data/Concept-QXlnt.jpg"></p>
0063
0064 - Qxlnt is a helper project that allows xlnt to be used in Qt.
0065 - xlnt is a excellent C++ library for using xlsx Excel files.
0066 - I was looking for a way to make it easy to use in Qt. Of course, cmake is compatible with Qt, but it is not convenient to use. So I created Qxlnt.
0067
0068 ### :star: <b>Qlibxlsxwriter</b> [https://github.com/QtExcel/Qlibxlsxwriter](https://github.com/QtExcel/Qlibxlsxwriter)
0069
0070 <p align="center"><img src="https://github.com/QtExcel/Qlibxlsxwriter/raw/master/markdown.data/logo.png"></p>
0071
0072 - Qlibxlsxwriter is a helper project that allows libxlsxwriter to be used in Qt.
0073 - libxlsxwriter is a C library for creating Excel XLSX files.
0074
0075 ### :star: <b>QSimpleXlsxWriter</b> [https://github.com/QtExcel/QSimpleXlsxWriter](https://github.com/QtExcel/QSimpleXlsxWriter)
0076
0077 - Use SimpleXlsxWriter in Qt.
0078 - SimpleXlsxWriter is C++ library for creating XLSX files for MS Excel 2007 and above.