Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions DCO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Developer Certificate of Origin
---

```
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# ChipFlow library

This is a small library to make working with the ChipFlow platform easy and straightforward.
This is a library to make working with the ChipFlow platform easy and straightforward.

## Installation and usage

This library uses [PDM](https://pdm.fming.dev/) for dependency management, testing, building, and publishing. Install PDM first. Then run:
See the `ChipFlow docs <https://docs.chipflow.io>`__

```
pdm install
```

To run tests, use:
## Contributing

```shell
pdm run test
```
We warmly accept [PRs](https://github.com/chipFlow/chipflow-lib/pulls)
and [issues](https://github.com/ChipFlow/chipflow-lib/issues), and are
always happy for folk to join in [GitHub Discussions](https://github.com/ChipFlow/chipflow-central/discussions)

To run lints, use:

```shell
pdm run lint
```
Code contributions must pass the following checks:
- `pdm lint`
- `pdm test`

Your contributions must pass the lint check to be included in the repository.
Also, do note we have a [DCO](https://developercertificate.org/), and require sign-offs from external contributors.

Happy hacking!

## License

Expand Down
12 changes: 2 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
ChipFlow Library Documentation
==============================

.. image:: _assets/chipflow-logo.svg
:width: 200px
:class: sd-m-auto
:name: landing-page-logo
``chipflow_lib`` is a Python library and tools for working with the `ChipFlow Platform <https://doc.chipflow.io>`__


ChipFlow IC Design Platform
---------------------------

ChipFlow is an open-source platform for designing, testing, and manufacturing custom silicon.
It provides a streamlined workflow from design to fabrication using Python and the Amaranth HDL.
It is developed at https://github.com/chipFlow/chipflow-lib/ and licensed `BSD 2-Clause <https://github.com/chipFlow/chipflow-lib/?tab=BSD-2-Clause-1-ov-file>`__

.. toctree::
:maxdepth: 2
Expand Down
Loading