Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

show features in README.md #747

Open
CagtayFabry opened this issue Apr 29, 2022 · 3 comments
Open

show features in README.md #747

CagtayFabry opened this issue Apr 29, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@CagtayFabry
Copy link
Member

update the README.md file to show code and screenshots / gifs of the main features
@CagtayFabry CagtayFabry added the documentation Improvements or additions to documentation label Apr 29, 2022
@CagtayFabry CagtayFabry added this to the 0.6.1 milestone Apr 29, 2022
@marscher
Copy link
Collaborator

That would be a nice improvement indeed.

@marscher
Copy link
Collaborator

Do we want these gifs to be generated and stored inside the sphinx documentation? That way we could just link these files in readme, and do not need to store them inside the repo.

This tool might become handy for that purpose
https://github.com/jwkvam/celluloid

@CagtayFabry
Copy link
Member Author

for the gifs I was thinking mostly about a nice k3d demonstration

personally I am fine with keeping some smaller static files like those in the docs folder

@CagtayFabry CagtayFabry removed this from the 0.6.2 milestone Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@marscher @CagtayFabry