Skip to content

Commit 007f7c7

Browse files
authored
Update README.md
1 parent 6ffc1d0 commit 007f7c7

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# cppreference2mshelp
22
cppreference.com html archive to microsoft help converter
3+
4+
## Prerequires:
5+
6+
1) Windows x64 (LOL, I'm mad)
7+
2) php al least 5.6.1
8+
3) digital certificate to sign cabs (unsigned cabs will not be installed)
9+
4) cppreference.com offline archive (*Html book*) downloaded from this link: http://en.cppreference.com/w/Cppreference:Archives
10+
11+
## Ok, what's inside?
12+
13+
**compile_c.cmd** and **compile_cpp.cmd** - main command files that do the all job. Use **compile_c.cmd** for c documentation and **compile_cp.cmd** for c++ documentation.
14+
**compile_c_zip.ps1** and **compile_cpp_zip.ps1** - uses powershell to make zip files.
15+
**config.txt** - config for a great tool *tidy*: http://www.html-tidy.org/ ( we need it to convert htmls to xhtmls and fix errors ).
16+
**cppreference.msha** and **creference.msha** - config files for *Microsoft Help System*. Actually a headers for Help system, *Microsoft Help* will get the info from them to install the help packs.
17+
**make_xhtmls.php** - ugly php preprocessor script that fixes and converts thousands of htmls from cppreference to xhtml and Microsoft Help format.
18+
**makecab.exe** - tool to make a cab file for Microsoft Help System. Can be found in Microsoft SDK.
19+
**signtool.exe** - tool to sign cab files. Can be found in Microsoft SDK.
20+
**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/
21+
22+
## Step-by-step instructions:
23+
24+
1) download [cppreference.com](http://en.cppreference.com/w/Cppreference:Archives) offline archive and unpack it. Only *Html book* format is acceptable.
25+
2) download this repo and unpack it to the **reference** folder inside unpacked archive (from cppreference.com).
26+
3) folders structure should be like this one:
27+
28+
![screenshot](https://github.com/crea7or/cppreference2mshelp/raw/master/folders.png)
29+
30+
Folders **common** and **en** is from archive from cppreference, all other folders is owned by script.
31+
32+
4) now you can start the scripts and build the documentation (200+ seconds for c++ documentation 4000 files and a lot less for c documentation).
33+
34+
5) In result you should have two new files in this folder: **cppreference.cab** and **creference.cab** - use them with appropriate **cppreference.msha** and **creference.msha** files to install created help files.
35+
36+
Enjoy!

0 commit comments

Comments
 (0)