]> git.saurik.com Git - wxWidgets.git/commitdiff
rename README to README.txt to be compat with win systems
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Mon, 6 Oct 2008 09:31:44 +0000 (09:31 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Mon, 6 Oct 2008 09:31:44 +0000 (09:31 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56104 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

utils/ifacecheck/README [deleted file]
utils/ifacecheck/README.txt [new file with mode: 0644]

diff --git a/utils/ifacecheck/README b/utils/ifacecheck/README
deleted file mode 100644 (file)
index df2fdc8..0000000
+++ /dev/null
@@ -1,55 +0,0 @@
-
- Ifacecheck utility
- ==================
-
- 1) INTRODUCTION
-
- This utility compares the wxWidgets real interface contained in the "include"
- hierarchy with the wxWidgets interface used for documentation purposes and
- kept in the @c interface hierarchy.
-
- Ifacecheck warns about incoherences (mainly wrong prototype signatures) and
- can even correct them automatically. It uses the XML outputs of the gccxml utility
- (see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org)
- to do the comparisons.
-
- It's explicitely designed for wxWidgets documentation needs and is probably of little
- use for anything else than wxWidgets docs reviewing.
-
-
- 2) PREREQUISITES FOR USING IT
-
- To use this utility you'll need at least:
-  - wxWidgets "include" and "interface" headers tree
-  - Doxygen installed
-  - Gccxml installed
-
-
- 3) HOW TO USE IT (on Linux)
-
-    First, create the doxygen XML:
-
-     > cd docs/doxygen
-     > ./regen.sh xml
-     > cd ../..
-
-    Next, create the gcc XML:
-
-     > ./configure                # configure wxWidgets as you would do when building it
-     > cd utils/ifacecheck
-     > ./rungccxml.sh
-     > cd ../..
-
-    Last, build and run ifacecheck:
-
-     > cd utils/ifacecheck/src
-     > make
-     > make install
-     > cd ..
-     > ifacecheck -u wxapi-preproc.txt wxapi.xml ../../docs/doxygen/out/xml/index.xml >ifacecheck.log
-
-    Now you should have the log of the utility saved in 'ifacecheck.log'.
-    Its contents should be easy to interpret.
-
-    For more info about ifacecheck options just type:
-     > ifacecheck --help
diff --git a/utils/ifacecheck/README.txt b/utils/ifacecheck/README.txt
new file mode 100644 (file)
index 0000000..df2fdc8
--- /dev/null
@@ -0,0 +1,55 @@
+
+ Ifacecheck utility
+ ==================
+
+ 1) INTRODUCTION
+
+ This utility compares the wxWidgets real interface contained in the "include"
+ hierarchy with the wxWidgets interface used for documentation purposes and
+ kept in the @c interface hierarchy.
+
+ Ifacecheck warns about incoherences (mainly wrong prototype signatures) and
+ can even correct them automatically. It uses the XML outputs of the gccxml utility
+ (see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org)
+ to do the comparisons.
+
+ It's explicitely designed for wxWidgets documentation needs and is probably of little
+ use for anything else than wxWidgets docs reviewing.
+
+
+ 2) PREREQUISITES FOR USING IT
+
+ To use this utility you'll need at least:
+  - wxWidgets "include" and "interface" headers tree
+  - Doxygen installed
+  - Gccxml installed
+
+
+ 3) HOW TO USE IT (on Linux)
+
+    First, create the doxygen XML:
+
+     > cd docs/doxygen
+     > ./regen.sh xml
+     > cd ../..
+
+    Next, create the gcc XML:
+
+     > ./configure                # configure wxWidgets as you would do when building it
+     > cd utils/ifacecheck
+     > ./rungccxml.sh
+     > cd ../..
+
+    Last, build and run ifacecheck:
+
+     > cd utils/ifacecheck/src
+     > make
+     > make install
+     > cd ..
+     > ifacecheck -u wxapi-preproc.txt wxapi.xml ../../docs/doxygen/out/xml/index.xml >ifacecheck.log
+
+    Now you should have the log of the utility saved in 'ifacecheck.log'.
+    Its contents should be easy to interpret.
+
+    For more info about ifacecheck options just type:
+     > ifacecheck --help