Skip to content

Update README and GitHub Pages site - #37

Merged
EndrII merged 3 commits into
mainfrom
task_36
Oct 14, 2026
Merged

EndrII merged 3 commits into
mainfrom
task_36

Conversation

@QuasarAppCI

Copy link
Copy Markdown
Member

What

Updates the README and brings the GitHub Pages site in sync with the current state of the library.

README.md

  • Fix minigmp version: 6.1.2 → 6.3.0 (the bundled mini-gmp was updated to GMP 6.3.0 in Update mini-gmp to GMP 6.3.0 (Issue #32) #33, tag v1.1.0)
  • Add a Documentation section linking to the GitHub Pages site (https://quasarapp.github.io/QtBigInt/)
  • Add a License section (LGPL-3.0)
  • Typo fixes: "Power by" → "Powered by", "incuding" → "including", "do not required" → "does not require", "makes as a static library" → "is built as a static library"

pages/index.html (GitHub Pages landing page)

  • minigmp 6.1.2 → 6.3.0
  • Remove qmake references (qmake build files were deleted in Remove qmake #35)
  • Fix the broken link to the removed #build anchor → #include-cmake
  • Add explicit README and API Reference links (the README is rendered as the Doxygen main page at doc/index.html and deployed to GitHub Pages by the existing deploy-docs.yml workflow on merge)

Verification

  • CMake build (Ninja, Release, Qt 6.12.0): clean
  • Test suite tests/QtBigintTest: 26/26 PASS
  • Doxygen run: 0 errors; updated README (6.3.0, Documentation + License sections) rendered as the site main page

Closes #36

- README: fix minigmp version (6.1.2 -> 6.3.0 after #33), add Documentation
  section linking to the GitHub Pages site, add License section (LGPL-3.0),
  fix typos (Power by, incuding, do not required, makes as)
- pages/index.html: refresh landing page to match the updated README
  (minigmp 6.3.0, drop removed qmake references, fix removed #build anchor,
  add explicit README / API Reference links)

Closes #36
@QuasarAppCI QuasarAppCI mentioned this pull request Oct 14, 2026
- Full human-readable Doxygen comments for the whole BigInt class in src/bigint.h
  (class overview, @code example, @snippet of the full example, brief+detailed
  docs for every public member; BigInt::log documented as not implemented).
- New examples/bigint_usage_example.cpp: complete standalone-compilable usage
  example (verified: compiles and runs against the library sources), with
  // [usage] markers so the @snippet block extracts the program.
- doxygen.conf: EXAMPLE_PATH=examples (standalone example page + Examples tab),
  IMAGE_PATH fixed to res, removed 14 obsolete tags -> doxygen exits 0 with
  0 errors and 0 warnings.
- README.md: banner moved below the description so the Doxygen main-page title
  is clean; link to the example file.
- pages/index.html: quick-example section linking the example file and docs.
- CMake Ninja Release rebuild OK; QtBigintTest 26/26 PASS.
@QuasarAppCI

Copy link
Copy Markdown
Member Author

Added the human-readable Doxygen documentation and the usage example requested in the review:

  • src/bigint.h: full Doxygen documentation for the whole BigInt class - class overview (arbitrary precision, operator set, division semantics, thread-safety warning), a short inline @code example, an @snippet of the complete example, and brief + detailed docs for every public member. BigInt::log(int base) is documented explicitly as not implemented (it is declared but has no implementation).
  • examples/bigint_usage_example.cpp: new standalone-compilable usage example (construction from int/string, arithmetic, pow, powm, gcd, isPrime, comparisons, base-2/10/16 string conversions). Verified: compiles with the command in its header and runs correctly.
  • doxygen.conf: EXAMPLE_PATH = examples (renders the standalone example page + the new Examples tab), IMAGE_PATH fixed from the broken ./QtBigInt/res to res, and 14 obsolete tags removed.
  • README.md: banner moved below the one-line description so the rendered Doxygen main page has a clean title; link to the example file.

Verification: Doxygen 1.9.8 run exits 0 with 0 errors and 0 warnings; docs/classBigInt.html contains the usage snippet, the standalone page docs/examples_2bigint_usage_example_8cpp-example.html is generated with the Examples tab in the menu, and the banner image from res/ renders on the main page. CMake Ninja Release rebuild OK and QtBigintTest passes 26/26.

Comment thread examples/bigint_usage_example.cpp Resolved
Signed-off-by: Andrei Yankovich <endriipersonal@gmail.com>
@EndrII
EndrII enabled auto-merge October 14, 2026 10:02
@EndrII
EndrII merged commit 51625a6 into main Oct 14, 2026
2 checks passed
@EndrII
EndrII deleted the task_36 branch October 14, 2026 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Readme

2 participants