Skip to content

Add kani logo - #1157

Merged
danielsn merged 2 commits into
model-checking:mainfrom
danielsn:logo
May 4, 2022
Merged

Add kani logo#1157
danielsn merged 2 commits into
model-checking:mainfrom
danielsn:logo

Conversation

@danielsn

Copy link
Copy Markdown
Contributor

Description of changes:

Adds our logo and favicon to the repo.

Resolved issues:

NA

Call-outs:

Testing:

  • How is this change tested? NA

  • Is this a refactor change? NA

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@danielsn
danielsn requested a review from a team as a code ownerMay 4, 2022 14:49
@danielsn
danielsnforce-pushed the logo branch 2 times, most recently from 228a75b to 7a13a1dCompareMay 4, 2022 14:51

@jaisnanjaisnan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Assuming that .ico and .png cover the logo files.

@danielsn
danielsn merged commit e3af7d2 into model-checking:mainMay 4, 2022
@danielsn
danielsn deleted the logo branch May 4, 2022 15:41
feliperodri added a commit to feliperodri/kani that referenced this pull request Aug 17, 2026
Added alongside the logo in model-checking#1157 but never referenced. The documentation site
is built by `scripts/build-docs.sh` and published from `docs/book/`, so a
repository-root icon never reaches it; mdBook takes its favicon from
`theme/favicon.{png,svg}`, which this repository does not override. It is also
absent from the `include` list in `Cargo.toml`, so it is not packaged into the
`kani-verifier` crate, and GitHub does not use repository-root icons.
feliperodri added a commit to tautschnig/kani that referenced this pull request Aug 25, 2026
…el-checking#4741)
Housekeeping for a few files that are either stale or undocumented, plus
proper
citation metadata now that the Kani paper is published. Each commit
stands alone.
**Citation metadata.** Adds `CITATION.cff` whose `preferred-citation`
points at the
ASE '26 paper, so GitHub's *Cite this repository* button emits the paper
rather than a
bare software reference, and adds a "Citing Kani" section to the README
with the ACM
Reference Format and a ready-to-paste BibTeX entry.
**Removes the VSTTE 2024 paper sources.** Nothing builds them, the paper
is published,
and the ASE 2026 paper is now the citation of record. Still available in
git history.
**Removes `favicon.ico`.** Added with the logo in model-checking#1157 and never
referenced. The docs
site is published from `docs/book/`, so a repository-root icon never
reaches it, and
mdBook takes its favicon from `theme/favicon.{png,svg}`, which we don't
override. It's
also absent from the `include` list in `Cargo.toml`, so it isn't
packaged into the
`kani-verifier` crate.
**Removes six orphaned `Dockerfile.bundle-test-*` files.** They were
built by the
`TestAlternativePlatforms` job of `release.yml`, removed in model-checking#3744 when
Ubuntu 18.04/AL2
support was dropped; that PR deleted only the 18.04 Dockerfile and left
the rest behind.
They're also stale — `bundle-test-al2` installs `kani-verifier` from
crates.io with the
bundle-install lines commented out, so it wasn't testing the bundle
under test. Bundle
installation is covered natively by the `TestBundle` job across the
macOS and Ubuntu
runners.
**Documents the remaining CI helpers.** Adds `scripts/ci/README.md`
explaining that
`Dockerfile.bundle-release-24-04` builds the
`ghcr.io/model-checking/kani-ubuntu-24.04`
image published by the `Package Docker` job on release tags, why it
can't be built from
a clean checkout, and the commands that produce the artifacts it
expects. Also records
why the root `.dockerignore` exists and that `run-copyright-check.sh`
needs GNU `xargs`.
Manual testing:
- `CITATION.cff` validates against CFF schema 1.2.0 (`cffconvert
--validate`), and
`ruby-cff` (the library behind GitHub's citation widget) renders it as a
complete
`@inproceedings` entry with all authors and the DOI.
- Ran the copyright check over all tracked files, including the new
`CITATION.cff`:
passes. Note it needs a BSD-compatible `xargs` invocation to run on
macOS.
- Grepped the tree for references to every deleted path: none remain.
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 and MIT licenses.
Sign up for freeto 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.

2 participants

@danielsn@jaisnan