Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
PeterFeicht committed Nov 10, 2024
1 parent d0a5b77 commit 8e6a0bb
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Information
-----------

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

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

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

Additional changes from upstream are:

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

0 comments on commit 8e6a0bb

Please sign in to comment.