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

Browse Source
This commit is contained in:
Thomas Fussell 2016-07-06 07:13:42 -04:00
parent a1688c7e48
commit 4aeab7bdfa
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -46,22 +46,25 @@ for(auto row : wb2["sheet2"].rows())
``` ```
## Building ## Building
xlnt uses continous integration and passes all 200+ tests in GCC 4.9, VS2015, and Clang (using Apple LLVM 7.0). xlnt uses continous integration and passes all 300+ tests in GCC 4.9, VS2015, and Clang (using Apple LLVM 7.0).
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 (more information on generators can be found [here](https://cmake.org/cmake/help/v3.3/manual/cmake-generators.7.html)). 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). 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. A full list of cmake generators can be found [here](https://cmake.org/cmake/help/v3.0/manual/cmake-generators.7.html). A basic build would look like (starting in the root xlnt directory):
Example Build (shared library by default):
```bash ```bash
./configure mkdir build
cd build cd build
make cmake ..
make -j8
``` ```
Example Build, static library with tests: The resulting library, libxlnt.dylib or libxlnt.so or xlnt.dll, would be found in the build/lib directory. Other cmake configuration options can be found using "cmake -LH". These options include shared vs static library and whether to build tests or not. An example of building a static library with tests as an Xcode project:
```bash ```bash
./configure --enable-static --disable-shared --enable-tests mkdir build
cd build cd build
make cmake -D TESTS=1 -D SHARED=0 -D STATIC=1 -G Xcode ..
cmake --build .
bin/xlnt.test
``` ```
## Dependencies ## Dependencies
@ -72,6 +75,11 @@ xlnt uses the following libraries, which are included in the source tree (all bu
- [utfcpp v2.3.4](http://utfcpp.sourceforge.net/) (Boost Software License, Version 1.0) - [utfcpp v2.3.4](http://utfcpp.sourceforge.net/) (Boost Software License, Version 1.0)
- [cxxtest v4.4](http://cxxtest.com/) (LGPLv3 license [only used for testing, separate from main library assembly]) - [cxxtest v4.4](http://cxxtest.com/) (LGPLv3 license [only used for testing, separate from main library assembly])
Initialize the submodules with this command:
```bash
git submodule update --init
```
## Documentation ## Documentation
More extensive documentation with examples can be found on [Read The Docs](http://xlnt.readthedocs.org/en/latest/). More extensive documentation with examples can be found on [Read The Docs](http://xlnt.readthedocs.org/en/latest/).
@ -79,7 +87,7 @@ More extensive documentation with examples can be found on [Read The Docs](http:
## License ## License
xlnt is currently released to the public for free under the terms of the MIT License: xlnt is currently released to the public for free under the terms of the MIT License:
Copyright (c) 2015 Thomas Fussell Copyright (c) 2015-2016 Thomas Fussell
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal