OSDN Git Service

Rename some more readme.txt to README.md
authorTim Gerundt <tim@gerundt.de>
Mon, 24 Sep 2018 21:15:09 +0000 (23:15 +0200)
committerTim Gerundt <tim@gerundt.de>
Mon, 24 Sep 2018 21:15:09 +0000 (23:15 +0200)
Installer/InnoSetup/README.md [moved from Installer/InnoSetup/readme.txt with 76% similarity]
Testing/GoogleTest/README.md [moved from Testing/GoogleTest/Readme.txt with 70% similarity]
Testing/selftests/README.md [new file with mode: 0755]
Testing/selftests/readme.txt [deleted file]
Tools/Scripts/README.md [moved from Tools/Scripts/ReadMe.txt with 97% similarity]

similarity index 76%
rename from Installer/InnoSetup/readme.txt
rename to Installer/InnoSetup/README.md
index 79a84d8..416730c 100755 (executable)
@@ -1,4 +1,4 @@
-WinMerge\InnoSetup\readme.txt
+# WinMerge InnoSetup
 
 InnoSetup holds the source for the WinMerge setup program, which uses the
 InnoSetup setup engine.
similarity index 70%
rename from Testing/GoogleTest/Readme.txt
rename to Testing/GoogleTest/README.md
index 190b9b5..44f9e20 100644 (file)
@@ -1,24 +1,25 @@
-Quick help to get started with Google Test for WinMerge:
+Quick help to get started with Google Test for WinMerge
+=======================================================
 
 As name suggest, this test set uses Google's unit testing framework. So first
 you need to get Google Test sources from:
 
-http://code.google.com/p/googletest/
+<http://code.google.com/p/googletest/>
 [download the .zip file for Windows]
 
-Unzip and compile Google Test library:
---------------------------------------
+Unzip and compile Google Test library
+-------------------------------------
 
 Unzip the Google Test sources to some folder. Pick a folder you can keep around
 (not some temp folder) because you'll need the header files every time you
 compile unit tests.
 
-Open solution file to Visual Studio. The file is in subfolder msvc\gtest.sln
+Open solution file to Visual Studio. The file is in subfolder `msvc\gtest.sln`
 
 Build the 'Release' target of 'gtest' project. You don't need to build other
 projects or targets. Indeed, 'rebuild all' for the solution does not work.
 
-Copy the gtest.lib file from msvc\Release subfolder to Testing\GoogleTest-
+Copy the gtest.lib file from `msvc\Release` subfolder to `Testing\GoogleTest`-
 folder in WinMerge source tree.
 
 Setup Visual Studio for Google Test
@@ -28,14 +29,14 @@ As mentioned earlier Google Test header files are needed to compile the tests.
 As the Google Test was unzipped to separate folder we must first tell VS where
 to find those headers.
 
-Add the gtest-[version]\include -folder to Visual Studio's include file
+Add the `gtest-[version]\include` -folder to Visual Studio's include file
 folders:
 
 * Open Options -dialog in Visual Studio
 * Select Projects and solutions
 * Select VC++ Directories
 * Select Include files
-* Add gtest-[version]\include -folder as *LAST* folder in that list
+* Add `gtest-[version]\include` -folder as *LAST* folder in that list
 
 Open the test project into Visual Studio and compile
 ----------------------------------------------------
@@ -47,7 +48,7 @@ Run the tests
 -------------
 
 Open the Command Prompt and CD to folder where executable were build, usually
-[projectname]/Release
+`[projectname]/Release`
 
 Run the executable.
 
diff --git a/Testing/selftests/README.md b/Testing/selftests/README.md
new file mode 100755 (executable)
index 0000000..7ded87f
--- /dev/null
@@ -0,0 +1,8 @@
+# WinMerge selftests
+
+The `testdiff.pl` perl script runs WinMerge through a series of diff tests,
+using test files in the subdirectories: `m` for files with mac line endings,
+`u` for unix line endings, and `w` for files with windows line endings.
+
+This file invokes the Unicode Debug compiled versions of `diff2winmergeU.exe`
+and `WinMergeU.exe`, via relative paths.
diff --git a/Testing/selftests/readme.txt b/Testing/selftests/readme.txt
deleted file mode 100755 (executable)
index 6df924c..0000000
+++ /dev/null
@@ -1,8 +0,0 @@
-selftests
-
-The testdiff.pl perl script runs WinMerge through a series of diff tests,
-using test files in the subdirectories: m for files with mac line endings,
-u for unix line endings, and w for files with windows line endings.
-
-This file invokes the Unicode Debug compiled versions of diff2winmergeU.exe
-and WinMergeU.exe, via relative paths.
similarity index 97%
rename from Tools/Scripts/ReadMe.txt
rename to Tools/Scripts/README.md
index 43bd0e2..7db4158 100644 (file)
@@ -16,10 +16,12 @@ changelog.py
  Python script creating a changelog from SVN. The script reads a commit log
  from SVN and outputs formatted changelog.
 
+```
  Usage: python changelog.py [-h] [--help] [-r:n] [--revisions:n]
   Where:
    -h, --help print usage help
    -r:n, --revisions:n output log for last n revisions (default is 100)
+```
 
 
 CheckMenuResources.vbs
@@ -34,7 +36,7 @@ Script for creating a list of (hopefully) unused resource IDs.
 
 CheckVCProj.vbs
 ---------------
-Script for checking the file "Merge.vcproj".
+Script for checking the file `Merge.vcproj`.
 
 
 CompareProjectFiles.py
@@ -43,6 +45,7 @@ CompareProjectFiles.py
  This script compares the project files of different versions of VisualStudio
  as well as the list of files on disk and displays the discrepencies.
 
+```
  Usage: CompareProjectFiles [-h] [-b <basepath>] <from> <to>
   where:
     -h, --help              print this help
@@ -52,6 +55,7 @@ CompareProjectFiles.py
                              disk: files on disk
                              2003: VisualStudio 2003 project file
                              2008: VisualStudio 2008 project file
+```
 
 
 create_release.py
@@ -61,6 +65,7 @@ create_release.py
 
  Run from root folder (Src, Filters etc are subfolders).
 
+```
  Usage: create_release [-h] [-f file] [-v n] [-c] [-l]
   Where:
    -h, --help print usage help
@@ -71,6 +76,7 @@ create_release.py
   For example:
    create_release -v 2.7.7.1
    create_release -f versions.ini
+```
 
 
 fix_manifest.py
@@ -80,11 +86,13 @@ fix_manifest.py
  converting from VS2003 project. The XML the script (Python) writes is quite
  differently formatted that VS does it. Opening the project file once in VS
  and saving it fixes this formatting issue.
+
+```
   Usage: fix_manifest.py [-h] filename
    Where:
     filename is absolute or relative path to the project file.
     -h, --help Print usage help.
+```
 
 
 HeaderFileAutonomyVerificator.py
@@ -93,24 +101,28 @@ HeaderFileAutonomyVerificator.py
  Script that verifies if a C++ header file is missing #include directives or
  forward declarations.
 
+```
  Usage: HeaderFileAutonomyVerificator.py [-h] [-c commandfile] <headerfile>
   where:
     -h, --help              print this help
     -c, --commandfile <ARG> override the default compilation command with the one
                             defined in the file <ARG>
     <headerfile>            header file to test
+```
 
 
 IncludeFileDependencyAnalyzer.py
 --------------------------------
  Script for finding all the files included (directly or indirectly) by
  a C/C++ source file.
+
+```
  Usage: IncludeFileDependencyAnalyzer.py <file.i>
   where:
     <file.i>            is the preprocessor output of the compiler for a given C/C++ file.
                         Look at http://c2.com/cgi/wiki?CppDependencyAnalysis to learn how to
                         generate it.
+```
 
 
 SetVersions.py
@@ -122,9 +134,11 @@ tsvn_patch.py
 -------------
  Script for cleaning up TortoiseSVN created patch files to use with GNU patch.
 
+```
  Usage: python tsvn_patch.py [-b] patchfile
   where:
    -b, --nobak skip creating a backup file of the original patch file
+```
 
 
 UpdateTranslations.bat
@@ -139,11 +153,12 @@ UpgradeProjects.py
 ------------------
  A script for updating Visual Studio solution- and project-files from VS2003
  to newer versions (VS2005 or VS2008).
+
+```
  Usage: UpgradeProjects.py [-h] [path]
  Where:
    -h, --help Print this help.
    path Root path for WinMerge.
  For example: UpgradeProjects.py ../..
    which upgrades current project when run from Scripts folder.
\ No newline at end of file
+```