lowRISC / lowRISC/ibex

Add CITATION.cff for Standardized Ibex Citations

Open
#2,310 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type:Question
Dominant language
SystemVerilog
Stars
2.1k
Forks
810
Avg merge
5d 23h
Merged PRs (30d)
9

Description

Hi Ibex-team,

I’d like to propose adding a [CITATION.cff](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) file to the Ibex repository. This would help researchers and users cite Ibex consistently in academic (and professional) work.
I’ve generated a draft using [cffinit](https://citation-file-format.github.io/cff-initializer-javascript/#/finish) as a starting point:
```
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Ibex
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- name: lowRISC CIC
address: 7 Hills Road
city: Cambridge
post-code: CB2 1GE
country: GB
website: 'https://lowrisc.org/'
abstract: >-
Ibex is a production-quality open source 32-bit RISC-V CPU
core written in SystemVerilog. The CPU core is heavily
parametrizable and well suited for embedded control
applications. Ibex is being extensively verified and has
seen multiple tape-outs. Ibex supports the Integer (I) or
Embedded (E), Integer Multiplication and Division (M),
Compressed (C), and B (Bit Manipulation) extensions.
```

**Open Questions**:

1. **Authorship:** Should lowRISC CIC be the sole author, or would it be more appropriate to include the [PULP Platform](https://www.pulp-platform.org/) as a co-author (or primary author)?

2. **Additional Metadata:** Would you like to add a DOI, ORCID, version, or specific contributors (e.g., key maintainers) to the file?

3. **Preferred Citation Format:** Do you have existing guidelines for how Ibex should be cited (e.g., in papers or documentation, which I have missed)?

I’m happy to refine this further or submit a PR. Thanks for considering this!

Best,
Felix Uhle

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the linked CITATION.cff documentation and the draft in the issue; confirm the preferred authorship and metadata with maintainers before editing. Add and validate CITATION.cff once those questions are settled, ensuring it accurately represents Ibex and its citation guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.