Skip to content

Commit

Permalink
Prep for release 0.0.2.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcnamara committed Jun 26, 2014
1 parent 63f1419 commit f99ef5a
Show file tree
Hide file tree
Showing 6 changed files with 81 additions and 14 deletions.
5 changes: 5 additions & 0 deletions Changes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
@page changes Changes


## 0.0.2 June 26 2014

- First public release.


## 0.0.1 June 8 2014

- First GitHub release.
Expand Down
63 changes: 61 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,67 @@
# libxlsxwriter


A C library for creating Excel XLSX files.

The libxlsxwriter library.

![demo image](http://libxlsxwriter.github.io/demo.png)

Work in Progress. Check back later.

## The libxlsxwriter library

Libxlsxwriter is a C library that can be used to write text, numbers and formulas to multiple worksheets in an Excel 2007+ XLSX file.

It supports features such as:

- 100% compatible Excel XLSX files
- Full Excel formatting
- Memory optimisation mode for writing large files
- Source code available on [GitHub](https://github.com/jmcnamara/libxlsxwriter)
- FreeBSD license
- ANSI C
- Works with GCC 4.4, 4.6, 4.7, 4.8, tcc and clang
- Works on Linux, FreeBSD and OS X.
- The only dependency is on `zlib`


Here is an example that was used to create the spreadsheet shown above:


```C
#include "xlsxwriter.h"

int main() {

/* Create a new workbook and add a worksheet. */
lxw_workbook *workbook = new_workbook("demo.xlsx");
lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);

/* Add a format. */
lxw_format *format = workbook_add_format(workbook);

/* Set the bold property for the format */
format_set_bold(format);

/* Widen the first column to make the text clearer. */
worksheet_set_column(worksheet, 0, 0, 20, NULL, NULL);

/* Write some simple text. */
worksheet_write_string(worksheet, 0, 0, "Hello", NULL);

/* Text with formatting. */
worksheet_write_string(worksheet, 1, 0, "World", format);

/* Writer some numbers. */
worksheet_write_number(worksheet, 2, 0, 123, NULL);
worksheet_write_number(worksheet, 3, 0, 123.456, NULL);

workbook_close(workbook);

return 0;
}

```



See the [full documentation](http://libxlsxwriter.github.io)for the getting started guide, a tutorial, the main API documentation and examples.
1 change: 1 addition & 0 deletions docs/src/getting_started.dox
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Build the source code as follows:

cd libxlsxwriter
make
# For FreeBSD use gmake instead of make

This will create a static and dynamic library in the local `./lib` directory:

Expand Down
7 changes: 0 additions & 7 deletions docs/src/introduction.dox
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,6 @@ Libxlsxwriter is a C port of the Perl
module and the Python [XlsxWriter](http://xlsxwriter.readthedocs.org) module
and is licensed under a FreeBSD @ref license.


@note

The 0.0.1 version of libxlsxwriter should be considered as a beta. In
particular it has some known performance/memory limitations that will be fixed
in the next releases.

Next: @ref getting_started

*/
17 changes: 13 additions & 4 deletions docs/src/mainpage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,13 @@

@section mainpage_intro libxlsxwriter

Note: this is preliminary documentation. The libxlsxwriter library isn't
released yet.

Libxlsxwriter is a C library that can be used to write text, numbers and
formulas to multiple worksheets in an Excel 2007+ XLSX file. It supports
features such as:

- 100% compatible Excel XLSX files
- Full formatting
- Full Excel formatting
- Memory optimisation mode for writing large files
- Source code available on [GitHub](https://github.com/jmcnamara/libxlsxwriter)
- FreeBSD @ref license
- ANSI C
Expand All @@ -40,6 +38,17 @@ following sections for more information:
- @ref worksheet.h "The Worksheet object"
- @ref format.h "The Format object"

- @ref working_with_formats
- @ref working_with_colors
- @ref working_with_dates
- @ref working_with_memory

- @ref examples
- @ref running_the_tests
- @ref faq
- @ref bugs
- @ref author
- @ref license
- @ref changes

*/
2 changes: 1 addition & 1 deletion include/xlsxwriter.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@
#include "xlsxwriter/format.h"
#include "xlsxwriter/utility.h"

#define LXW_VERSION "0.0.1"
#define LXW_VERSION "0.0.2"

#endif /* __LXW_XLSXWRITER_H__ */

0 comments on commit f99ef5a

Please sign in to comment.