https://github.com/ucb-ucie/uciedigital

Pure digital components of a UCIe controller
https://github.com/ucb-ucie/uciedigital

Last synced: 2 months ago
JSON representation

Pure digital components of a UCIe controller

• Host: GitHub
• URL: https://github.com/ucb-ucie/uciedigital
• Owner: ucb-ucie
• License: bsd-3-clause
• Created: 2023-09-04T01:08:40.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-28T12:41:35.000Z (3 months ago)
• Last Synced: 2024-10-28T16:29:31.168Z (3 months ago)
• Language: Scala
• Size: 1.86 MB
• Stars: 44
• Watchers: 13
• Forks: 4
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UCIe Digital IP

An open-source digital implementation of the UCIe 1.1 specification.

You can request a copy of the UCIe 1.1 specification [here](https://www.uciexpress.org/1-1-spec-download).

## Getting Started

Install [sbt](https://www.scala-sbt.org/).

If you run into issues building the Scala code,

you may need to switch to Java 17.

To run the tests, run `sbt test` from the root of this repository.

To compile the code, run `sbt compile`.

To format the code using scalafmt, run `sbt scalafmt`.

If you are running `sbt` commands frequently, you may find it useful

to leave the sbt shell (launched by running `sbt` with no arguments) open.

You can then compile/test the code from the sbt shell.

## Documentation

See the [API documentation](https://ucb-ucie.github.io/uciedigital/edu/berkeley/cs/ucie/digital/index.html).

The API docs are updated automatically in continuous integration.

## Contributing

If you'd like to contribute, please let us know. You can:

- Open an issue.

- Email [email protected] and [email protected].

  

Documentation updates, tests, and bugfixes are always welcome.

For larger feature additions, please discuss your ideas with us before implementing them.

Contributions can be submitted by opening a pull request against the main branch of this repository.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed under the BSD 3-Clause license, without any additional terms or conditions.