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.

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

Change flagship example in the Readme #294

Closed
lorepieri8 opened this issue May 12, 2023 · 1 comment
Closed

Change flagship example in the Readme #294

lorepieri8 opened this issue May 12, 2023 · 1 comment

Comments

@lorepieri8
Copy link

[Opinion-based issue, feel free to close.]

I propose to use the example shown in modeling as the flagship example, for instance on the README.

https://cpmpy.readthedocs.io/en/latest/modeling.html

It is very easy to understand and comprehensive at the same time, while the Sudoku example adds some unnecessary complexity due to the 2D nature.

@tias
Copy link
Collaborator

tias commented Jun 26, 2023

Hi Lorenzo,

you were absolutely right about the README, it was still from the early days of contrasting with other CP languages, rather than explaining the library as is.

We've just pushed our rework of the README and user docs, to be 'first user' friendly.

Kind regards,
Tias

@tias tias closed this as completed Jun 26, 2023
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

No branches or pull requests

2 participants