Skip to content

Commit

Permalink
Updated README files.
Browse files Browse the repository at this point in the history
  • Loading branch information
JFLarvoire committed Dec 4, 2018
1 parent a71c9f1 commit 1bf396f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 19 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This fork also adds one important program:
sml2.c is a trivial program, doing only the command-line parsing.
All the hard work is done by the modified libxml2 library.
sml2.exe is about 50 times faster than sml.tcl for converting very large files.
Use option -? or -h to display help.
Use option -? or -h to display help.
I'm particularly proud of the -f option, to reformat and reindent canonically
the output, whatever its kind.
This makes sml2.exe particularly useful to study complex XML files.
Expand All @@ -56,9 +56,9 @@ This fork also adds one important program:
Contrary to sml.tcl, sml2.c does not guaranty binary reversibility. That is:
An XML file converted to SML, then back to XML, may have changes in its non-
significant white spaces. This is due to a limitation of libxml2, which does
not record non-significant white spaces in the DOM tree.
not record non-significant white spaces in the DOM tree.
This is a problem for testing, as it's not possible to just do a binary
comparison to check the sml2.exe conversions correctness.
comparison to check the sml2.exe conversions correctness.
But this is not a problem for actual use, as non-significant white spaces
are (by definition) non-significant in XML and SML.

Expand Down Expand Up @@ -89,9 +89,11 @@ https://github.com/JFLarvoire/SysToolsLib/blob/master/Docs/System%20Script%20Lib

-------------------------------------------------------------------------------

Original README contents:

Full documentation for the standard version of libxml2 is available on-line at

   http://xmlsoft.org/
    http://xmlsoft.org/

This code is released under the MIT Licence see the Copyright file.

Expand All @@ -101,17 +103,17 @@ To build on an Unixised setup:

To build on Windows:

   see instructions on [win32/README.md](win32/README.md)
    see instructions on [win32/README.md](win32/README.md)

To assert build quality:
   on an Unixised setup:
      run make tests
   otherwise:
There is 3 standalone tools runtest.c runsuite.c testapi.c, which
should compile as part of the build or as any application would.
Launch them from this directory to get results, runtest checks
the proper functionning of libxml2 main APIs while testapi does
a full coverage check. Report failures to the list.
    on an Unixised setup:
        run `make tests`
    otherwise:
  There is 3 standalone tools runtest.c runsuite.c testapi.c, which
    should compile as part of the build or as any application would.
    Launch them from this directory to get results, runtest checks
    the proper functionning of libxml2 main APIs while testapi does
    a full coverage check. Report failures to the list.

To report bugs, follow the instructions at:
http://xmlsoft.org/bugs.html
Expand Down
15 changes: 9 additions & 6 deletions win32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,19 @@ that.
Changes for SML support
-----------------------

These changes are actually minor improvements, to simplify the Windows build process.
These changes are actually minor improvements, to simplify the Windows build process.
In the simplest case of a default build with Microsoft tools, it becomes exactly the same
as the Unix process:

I've added two batch scripts to help build it with Microsoft tools:
configure & make & make install

For that, I've added two batch scripts to help build with Unix-like commands:

- configure.bat: Front end to the existing configure.js script.
- make.bat: Front end to Microsoft nmake.exe or Borland bmake.exe.
(Copied by configure.js from make.msvc.bat and make.bcb.bat respectively.)

These scripts allow building the Windows version with commands that look the
same as the typical commands used to build the Unix versions:
### More detailed instructions for building with MSVC

To quickly build libxml2.lib and sml2.exe in Windows with Microsoft tools:
(Assuming you don't have the iconv library installed, as it is not by default.)
Expand Down Expand Up @@ -269,6 +272,6 @@ command-line tools.



Authors: Igor Zlatkovic <igor@zlatkovic.com>
Eric Zurcher <Eric.Zurcher@csiro.au>
Authors: Igor Zlatkovic <igor@zlatkovic.com>
Eric Zurcher <Eric.Zurcher@csiro.au>
Jean-François Larvoire <jf.larvoire@free.fr>

0 comments on commit 1bf396f

Please sign in to comment.