/prjunnamed

End-to-end synthesis and P&R toolchain

Primary LanguageRustBSD Zero Clause License0BSD

Project Unnamed

Project Unnamed aims to deliver a comprehensive end-to-end FPGA synthesis, placement, routing, and bitstream generation tools targeting multiple FPGA families and integrating with Project Combine.

The project is currently in the early stage of research and prototyping, and is not suitable for general use.

Development

In order to build Project Unnamed and run its testsuite, you will need Rust (latest stable release) and Z3. We recommend using rustup or installing Rust from the software repository of your Linux distribution. Once you have these tools, run:

$ cargo test

We use rustfmt to ensure consistent formatting of the entire codebase. Prior to sending a pull request, run:

$ cargo fmt

In order to build the documentation, you will need mdbook (which can be installed in a number of ways including via rustup). Once you have it, run:

$ mdbook serve docs

The documentation will be accessible in a browser at http://localhost:3000.

Community

Project Unnamed has a dedicated IRC channel, #prjunnamed at libera.chat, which is bridged1 to Matrix at #prjunnamed:catircservices.org. Feel free to join to discuss ongoing development of Project Unnamed and its related projects.

License

Project Unnamed is distributed under the terms of the 0-clause BSD license and the Apache License (Version 2.0).

By submitting your contribution you agree to be bound by all provisions of both of these licenses, including the clause 3 (Grant of Patent License) of the Apache License (Version 2.0).

Footnotes

  1. The same messages appear on IRC and on Matrix, and one can participate in the discussion equally using either communication system.