Skip to content

Adding cflib2 to the repository overview - #267

Open
enyanil wants to merge 1 commit into
masterfrom
enya/add-cflib2-overview
Open

Adding cflib2 to the repository overview#267
enyanil wants to merge 1 commit into
masterfrom
enya/add-cflib2-overview

Conversation

@enyanil

@enyanil enyanil commented Aug 12, 2026

Copy link
Copy Markdown
Member

I want to include something about the new cflib2 on the repo overview, while still being clear about the state and how it is connected to the v1.

@ArisMorgens

Copy link
Copy Markdown
Member

Nice addition, and I think it makes sense to add the README file as documentation for now.
However, the current README in cflib2 doesn't have instructions on how to get started with the lib (pip install cflib2 , uv add cflib2). Instead it covers the development side of the repo, for users that want to contribute to cflib2. We should maybe update that before merging this PR.

@ArisMorgens

Copy link
Copy Markdown
Member

Also, shouldn't the rust-lib be in the repository overview as well? On the one hand it's less user-friendly than the python libs but on the other hand it has concrete documentation: https://docs.rs/crazyflie-lib/latest/crazyflie_lib/

@enyanil

enyanil commented Aug 13, 2026

Copy link
Copy Markdown
Member Author

Nice addition, and I think it makes sense to add the README file as documentation for now. However, the current README in cflib2 doesn't have instructions on how to get started with the lib (pip install cflib2 , uv add cflib2). Instead it covers the development side of the repo, for users that want to contribute to cflib2. We should maybe update that before merging this PR.

Yes that makes sense, we should wait with this until then.

Also, shouldn't the rust-lib be in the repository overview as well? On the one hand it's less user-friendly than the python libs but on the other hand it has concrete documentation: https://docs.rs/crazyflie-lib/latest/crazyflie_lib/

Yes we include almost everything in this overview so this should also be included. I'll add it!

Sign up for free to 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