Browse Source

Several readme files fixes

General:
Fix HTML tag in general readme.
Rework HTML teletype, <tt>, to code, <code>
(teletype is deprecated in HTML5 and code is generally what we mean).
Rework few tags in Win32 readme
(for consistency with general readme).
Fix typo.
pull/42/head
Helder Magalhães 13 years ago
parent
commit
292bbb0cd1
2 changed files with 59 additions and 54 deletions
  1. +24
    -20
      README-WIN32.html
  2. +35
    -34
      README.html

+ 24
- 20
README-WIN32.html View File

@@ -7,44 +7,48 @@
<body>
<h2>Windows specific notes for JSON-C</h2>
<p>Please send Win32 bug reports to <a href="mailto:christopher.watford@gmail.com">christopher.watford@gmail.com</a></p>
<p><b>Win32 Specific Changes:</b></p>
<h3>Win32 Specific Changes</h3>
<ul>
<li>
Various functions have been redefined to their Win32 version (i.e. <tt>open</tt>
on win32 is <tt>_open</tt>)</li>
Various functions have been redefined to their Win32 version (i.e. <code>open</code>
on win32 is <code>_open</code>)</li>
<li>
Implemented missing functions from MS's libc (i.e. <tt>vasprintf</tt> and <tt>strndup</tt>)</li>
Implemented missing functions from MS's libc (i.e. <code>vasprintf</code> and <code>strndup</code>)</li>
<li>
Added code to allow Win64 support without integer resizing issues, this
probably makes it much nicer on 64bit machines everywhere (i.e. using <tt>ptrdiff_t</tt>
probably makes it much nicer on 64bit machines everywhere (i.e. using <code>ptrdiff_t</code>
for pointer math)</li>
</ul>
<p><b>Porting Changelog:</b></p>
<h3>Porting Changelog</h3>
<dl>
<dt><tt>printbuf.c</tt> - C. Watford (christopher.watford@gmail.com)</dt>
<dt><code>printbuf.c</code> - C. Watford (christopher.watford@gmail.com)</dt>
<dd>
Added a Win32/Win64 compliant implementation of <tt>vasprintf</tt></dd>
<dt><tt>debug.c</tt> - C. Watford (christopher.watford@gmail.com)</dt>
Added a Win32/Win64 compliant implementation of <code>vasprintf</code></dd>
<dt><code>debug.c</code> - C. Watford (christopher.watford@gmail.com)</dt>
<dd>
Removed usage of <tt>vsyslog</tt> on Win32/Win64 systems, needs to be handled
Removed usage of <code>vsyslog</code> on Win32/Win64 systems, needs to be handled
by a configure script</dd>
<dt><tt>json_object.c</tt> - C. Watford (christopher.watford@gmail.com)</dt>
<dt><code>json_object.c</code> - C. Watford (christopher.watford@gmail.com)</dt>
<dd>
Added scope operator to wrap usage of <tt>json_object_object_foreach</tt>, this needs to be
Added scope operator to wrap usage of <code>json_object_object_foreach</code>, this needs to be
rethought to be more ANSI C friendly</dd>
<dt><tt>json_object.h</tt> - C. Watford (christopher.watford@gmail.com)</dt>
<dt><code>json_object.h</code> - C. Watford (christopher.watford@gmail.com)</dt>
<dd>
Added Microsoft C friendly version of <tt>json_object_object_foreach</tt></dd>
<dt><tt>json_tokener.c</tt> - C. Watford (christopher.watford@gmail.com)</dt>
Added Microsoft C friendly version of <code>json_object_object_foreach</code></dd>
<dt><code>json_tokener.c</code> - C. Watford (christopher.watford@gmail.com)</dt>
<dd>
Added a Win32/Win64 compliant implementation of <tt>strndup</tt></dd>
<dt><tt>json_util.c</tt> - C. Watford (christopher.watford@gmail.com)</dt>
Added a Win32/Win64 compliant implementation of <code>strndup</code></dd>
<dt><code>json_util.c</code> - C. Watford (christopher.watford@gmail.com)</dt>
<dd>
Added cast and mask to suffice <tt>size_t</tt> v. <tt>unsigned int</tt>
Added cast and mask to suffice <code>size_t</code> v. <code>unsigned int</code>
conversion correctness</dd>
</dl>
<p>This program is free software; you can redistribute it and/or modify it under
the terms of the MIT License. See COPYING for details.</p>
<h3><a href="COPYING">License</a></h3>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the MIT License.</p>
<hr />
</body>
</html>

+ 35
- 34
README.html View File

@@ -1,34 +1,35 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>JSON-C - A JSON implementation in C</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<h2>JSON-C - A JSON implementation in C</h2>

<h3>Overview</h3>
<p>JSON-C implements a reference counting object model that allows you to easily
construct JSON objects in C, output them as JSON formatted strings and parse
JSON formatted strings back into the C representation of JSON objects.</p>

<h3>Building</h3>
<p>To setup JSON-C to build on your system please run <tt>configure</tt> and <tt>make</tt>.</p>
<p>If you are on Win32 and are not using the VS project file, be sure
to rename <tt>config.h.win32</tt> to <tt>config.h</tt> before building.</p>

<h3>Documentation</h3>
<P>Doxygen generated documentation exists <a href="doc/html/json__object_8h.html">here</a>
and Win32 specific notes can be found <a href="README-WIN32.html">here</a>.</P>

<h3><a href="https://github.com/json-c/json-c">GIT Reposository</a></h3>
<p><strong><code>git clone https://github.com/json-c/json-c.git</code></strong></p>

<h3><a href="http://groups.google.com/group/json-c">Mailing List</a></h3>
<pi>Send email to <strong><code>json-c <i>&lt;at&gt;</i> googlegroups <i>&lt;dot&gt;</i> com</code></strong></p>

<h3><a href="COPYING">License</a></h3>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the MIT License..</p>
<hr/>
</body>
</html>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>JSON-C - A JSON implementation in C</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<h2>JSON-C - A JSON implementation in C</h2>
<h3>Overview</h3>
<p>JSON-C implements a reference counting object model that allows you to easily
construct JSON objects in C, output them as JSON formatted strings and parse
JSON formatted strings back into the C representation of JSON objects.</p>
<h3>Building</h3>
<p>To setup JSON-C to build on your system please run <code>configure</code> and <code>make</code>.</p>
<p>If you are on Win32 and are not using the VS project file, be sure
to rename <code>config.h.win32</code> to <code>config.h</code> before building.</p>
<h3>Documentation</h3>
<p>Doxygen generated documentation exists <a href="doc/html/json__object_8h.html">here</a>
and Win32 specific notes can be found <a href="README-WIN32.html">here</a>.</p>
<h3><a href="https://github.com/json-c/json-c">GIT Repository</a></h3>
<p><strong><code>git clone https://github.com/json-c/json-c.git</code></strong></p>
<h3><a href="http://groups.google.com/group/json-c">Mailing List</a></h3>
<p>Send email to <strong><code>json-c <i>&lt;at&gt;</i> googlegroups <i>&lt;dot&gt;</i> com</code></strong></p>
<h3><a href="COPYING">License</a></h3>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the MIT License.</p>
<hr/>
</body>
</html>

Loading…
Cancel
Save