Skip to content

Commit 4ce9243

Browse files
authored
Update README.md
1 parent bda349e commit 4ce9243

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# cppreference2mshelp
2-
cppreference.com html archive to microsoft help converter
2+
cppreference.com html archive converter to microsoft help (for Windows Visual Studio 2012+) and good old .chm help (for any Windows and even some other platforms)
33

44
## Prerequires:
55

66
1) Windows x64 (LOL, I'm mad)
77
2) php al least 5.6.1
8-
3) digital certificate to sign cabs (unsigned cabs will not be installed)
8+
3) digital certificate to sign cabs for Visual Studio (because unsigned cabs will not be installed) CHM help does not require certificate
99
4) cppreference.com offline archive (*Html book*) downloaded from this link: http://en.cppreference.com/w/Cppreference:Archives
1010

1111
## Ok, what's inside?
@@ -20,13 +20,15 @@ cppreference.com html archive to microsoft help converter
2020

2121
**make_xhtmls.php** - ugly php preprocessor script that fixes and converts thousands of htmls from cppreference to xhtml and Microsoft Help format.
2222

23+
**make_chm.php** - another ugly script that makes chm help files: **cppreference.hhc** - table of contents, **cppreference.hhk** - keywords index and _Html Help_ project file - **cppreference.hhp** (for both c and c++). Launch this script directly to make chm help file.
24+
2325
**makecab.exe** - tool to make a cab file for Microsoft Help System. Can be found in Microsoft SDK.
2426

2527
**signtool.exe** - tool to sign cab files. Can be found in Microsoft SDK.
2628

2729
**tidy.exe** and **tidy.dll** - tool to convert html to xhtml and fix many other problems. Can be downloaded here: http://www.html-tidy.org/
2830

29-
## Step-by-step instructions:
31+
## Step-by-step instructions for Microsoft Help Files for Visual Studio:
3032

3133
1) download [cppreference.com](http://en.cppreference.com/w/Cppreference:Archives) offline archive and unpack it. Only *Html book* format is acceptable.
3234
2) download this repo and unpack it to the **reference** folder inside unpacked archive (from cppreference.com).
@@ -42,4 +44,6 @@ Folders **common** and **en** is from archive from cppreference, all other folde
4244

4345
**Note:** *This repo contain pre-build and signed files that are ready to install into Visual Studio 2012, Visual Studio 2013 (maybe 2015 and 2017 too - I can't test it right now - let me know if you'll do ).*
4446

47+
**Note:** *If you want to build chm help file, launch* **make_chm.php**. Pre-built cppreference.chm file is also added to this repo.
48+
4549
Enjoy!

0 commit comments

Comments
 (0)