Skip to content

Commit

Permalink
Doc updates for v0.4.2 release
Browse files Browse the repository at this point in the history
Updated top-level documentation files for the release of version 0.4.2.
  • Loading branch information
jcbollinger committed Jan 21, 2016
1 parent f5d4353 commit 1ddf445
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 18 deletions.
2 changes: 1 addition & 1 deletion NEWS
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
CIF API News
------------

2016-Jan-??
2016-Jan-21
Public release of version 0.4.2

2015-Oct-27
Expand Down
17 changes: 9 additions & 8 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,19 @@ Pre-built, doxygen-generated programmer's documentation is available in
dox-html/, and pre-built, doxygen-generated man pages are available in
dox-man/.

The package includes several example programs to demonstrate the API's usage;
The package includes several example programs to demonstrate API usage;
see src/examples. These may optionally be built (and installed) with the
API library. One of them is a text-mode CIF 2.0 file syntax checker, which
might be of some interest. Also, the tests (src/tests) collectively provide
a fairly comprehensive demonstration of the API's features, though their
primary purpose is to verify that the library works as intended.

The package now includes EXPERIMENTAL program 'cif_linguist' for converting
data between CIF formats. This program is not well tested and is certain to
contain bugs (though no specific bugs are known at this time). It is not
built or installed by default; to include it in the build, the package must
be configured with the --with-linguist option.
The package also includes EXPERIMENTAL program 'cif_linguist' for converting
data between various versions of the CIF format. It is not built or
installed by default on account of its experimental nature, but configure
option --with-linguist will cause it to be included for building and
installation.


Refer to file INSTALL for general installation instructions. Build details
specific to this package follow:
Expand Down Expand Up @@ -58,7 +59,7 @@ specific to this package follow:
* There are a few other project-specific configuration options, but
they are adequately explained in configure's help text.

The package has been built and tested successfully on Linux (CentOS 6, Debian;
The package has been built and tested successfully on Linux (CentOS 6, Debian);
this is the primary development platform), on OS X 10.8, and on Windows 7.
For OS X builds, the needed dependencies are readily available via the "Fink"
package management system and its public repositories, among other means.
Expand All @@ -67,7 +68,7 @@ further information is provided in file README_Windows. Those approaches
assume you want to use the provided package build system; other approaches
may be available if you want to build the project with a different toolchain,
such as Visual Studio on Windows or XCode on OS X. The project has few,
if any, toolchain dependencies, but no support is currently available for
if any, toolchain dependencies, but only limited support is available for
such build strategies.


Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ might be of some interest. Also, the tests (`src/tests/`) collectively provide
a fairly comprehensive demonstration of API features, though their
primary purpose is to verify that the library works as intended.

The package also includes EXPERIMENTAL program cif_linguist, which converts
The package also includes EXPERIMENTAL program `cif_linguist`, which converts
data between various versions of the CIF format. It is not built or
installed by default on account of its experimental nature, but configure
option --with-linguist will cause it to be included for building and
installed by default on account of its experimental nature, but `configure`
option `--with-linguist` will cause it to be included for building and
installation.

Refer to file INSTALL for general installation instructions. Build details
Expand All @@ -44,8 +44,10 @@ specific to this package follow:
Considerable effort was devoted, however, to restricting implementation code
to the intersection of standard C90 and standard C99, and additionally to
avoiding code that has different meaning in C and C++. With very few
caveats, any compiler that is compliant with any one of C90, C99, C2011,
C++98, or C++2011 should be able to build the project.
caveats, any compiler that is compliant with any one of C89/C90, C99, C2011,
C++98, or C++2011 should be able to build the project. Building with a
C++ compiler may require using the `--disable-c89-enforcement` configuration
option, however.

* At present, the `--enable-extra-warnings` configuration option is effective
only for gcc.
Expand Down Expand Up @@ -82,7 +84,7 @@ Tennessee, U.S.A.. Specific exceptions include, but are not necessarily
limited to, the contents of the 'uthash' directory; those files are
subject to the copyright statement and license in the file 'LICENSE' in
that directory, and it is subject to those terms that they are distributed
to you. Additionally, many components of the build system are
to you herein. Additionally, many components of the build system are
parts of, or were generated via, the GNU AutoTools suite. These contain
code belonging to the Free Software Foundation (FSF), and each is marked
with an FSF ownership notice and statements of rights. The FSF components
Expand Down
6 changes: 3 additions & 3 deletions ReleaseNotes
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ bugs and improving performance of the core CIF API library and its accompanying
example programs and tools. Notable changes include:

- New feature: cif_linguist now preserves whitespace and comments
- Modified SQLite usage for significant memory savings and a slight performance
gain.
- Improvement: modified SQLite usage for significant memory savings and a slight
performance gain.
- Added pkg-config support
- Added an RPM spec file to the distribution
- Bug fix: the numeric formatter incorrectly handled the case where all
significant figures are rounded away.
- Bug fix: the parser accepted "_" as a data name
- Bug fix: cif_linguist consistently crashed when outputting loop headers
- Several bug fixes in cif_analyze_string()
- Bug fix: several bug fixes in cif_analyze_string()


CIF_API 0.4.1 Release Notes
Expand Down

0 comments on commit 1ddf445

Please sign in to comment.