StarMirror/xlnt
1
0
Fork 0
mirror of https://github.com/tfussell/xlnt.git synced 2024-03-22 13:11:17 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Thomas Fussell 2015-11-03 18:58:36 -05:00
parent 5ef01e4cd1
commit 645182d2ae
1 changed files with 9 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -4,7 +4,7 @@ xlnt
[![Build Status](https://travis-ci.org/tfussell/xlnt.svg)](https://travis-ci.org/tfussell/xlnt)
## Introduction
xlnt is a C++14 library for reading, writing, and modifying XLSX files as described in [ECMA 376](http://www.ecma-international.org/publications/standards/Ecma-376.htm). The API is roughly based on [openpyxl](https://bitbucket.org/openpyxl/openpyxl), a python library for reading and writing xlsx/xlsm files. This is still very much a work in progress, but the core development work is complete.
xlnt is a C++14 library for reading, writing, and modifying XLSX files as described in [ECMA 376](http://www.ecma-international.org/publications/standards/Ecma-376.htm). The API is based on [openpyxl](https://bitbucket.org/openpyxl/openpyxl), a Python library to read/write Excel 2007 xlsx/xlsm files, and ultimately on [PHPExcel](https://github.com/PHPOffice/PHPExcel), pure PHP library for reading and writing spreadsheet files upon which openpyxl was based. This project is still very much a work in progress, but the core development work is complete.
## Usage
Including xlnt in your project
@ -41,31 +41,14 @@ for(auto row : wb2["sheet2"].rows())
```
## Building
xlnt is regularly built and passes all 200+ tests in GCC 4.8.2, MSVC 14, and Clang (using Apple LLVM 7.0).
xlnt is regularly built and passes all 200+ tests in GCC 4.8.2, VS2015, and Clang (using Apple LLVM 7.0).
Build configurations for Visual Studio 2015, GNU Make, and Xcode can be created using cmake and the cmake scripts in the project directory, cmake.
Build configurations for Visual Studio 2015, GNU Make, and Xcode can be created using [cmake](https://cmake.org/) and the cmake scripts in the project's cmake directory. To make this process easier, two python scripts are provided, configure and clean. configure will create build workspaces using the system's default cmake generator or the generator name provided as its first argument. Resulting build files can be found in the created directory "./build". The clean script simply removes ./bin, ./lib, and ./build directories. For Windows, two batch files, configure.bat and clean.bat, are wrappers around the correspnding scripts for convenience (can be double-clicked from Explorer).
In OSX, with Xcode:
Example Build:
```bash
mkdir build
./configure
cd build
cmake -G Xcode ../cmake
open xlnt.xcproject
```
In Windows, with Visual Studio 2015:
```batch
mkdir build
cd build
cmake -G "Visual Studio 14 2015" ../cmake
start xlnt.sln
```
In Linux or OSX, with GNU Make:
```bash
mkdir build
cd build
cmake -G "Unix Makefiles" ../cmake
make
```
@ -75,6 +58,10 @@ xlnt uses the following libraries, which are included in the source tree (pugixm
- [pugixml v1.6](http://pugixml.org/) (MIT license)
- [cxxtest v4.4](http://cxxtest.com/) (LGPLv3 license [only used for testing, separate from main library assembly])
## Documentation
Full documentation can be found on [Read The Docs](http://xlnt.readthedocs.org/en/latest/).
## License
xlnt is currently released to the public for free under the terms of the MIT License: