Skip to content

Commit 8e6a0bb

Browse files
committed
Improve README
This improves the README to clarify that this repo does not contain any Cppreference content, but is only for creating the offline archive. Fixes #35.
1 parent d0a5b77 commit 8e6a0bb

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
Information
22
-----------
33

4-
This is source package for Cppreference C++ standard library reference
5-
documentation available at <http://en.cppreference.com>.
4+
This is the source package used to build the offline archive for the
5+
Cppreference C++ standard library reference documentation available at
6+
<http://en.cppreference.com>.
67

78
If there is no 'reference/' subdirectory in this package, the actual
89
documentation is not present here and must be obtained separately in order to
@@ -55,10 +56,10 @@ About this fork
5556

5657
I made this fork mainly because the last official version of the offline package
5758
was rather old and much had changed with new C++ versions. Now I try to update
58-
roughly once a month.
59+
more frequently.
5960

6061
Additional changes from upstream are:
6162

6263
* Better layout by centering the content on the page.
6364
* Keeping links between the C and C++ parts of the documentation.
64-
* Keep a footer with a link to the online version of each page.
65+
* Keeping a footer with a link to the online version of each page.

0 commit comments

Comments
 (0)