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

Move README info to the doc? #2

Closed
tmigot opened this issue Oct 24, 2023 · 3 comments · Fixed by #4
Closed

Move README info to the doc? #2

tmigot opened this issue Oct 24, 2023 · 3 comments · Fixed by #4
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@tmigot
Copy link
Member

tmigot commented Oct 24, 2023

It feels more in the spirit of the package to have a generic README that would a JSO-compliant solver typically have, and move all the extra information to the documentation of this package.
@tmigot tmigot added documentation Improvements or additions to documentation question Further information is requested labels Oct 24, 2023
@abelsiqueira
Copy link
Member

I agree with moving, but I think a more prominent place. Maybe SolverCore? Maybe the website? Both?

@tmigot
Copy link
Member Author

tmigot commented Oct 24, 2023

SolverCore would be good, but I feel it is less visited than the website, and also it is probably good to have everything on the website anyway.

@abelsiqueira
Copy link
Member

I agree to have in the website and some other place. I think SolverCore because it probably only affects people that have to use SolverCore anyway because they're developing solvers.

This was referenced Dec 20, 2023
Merged
Merged
@tmigot tmigot closed this as completed in #4 Dec 22, 2023
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 question Further information is requested
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add standard JSO-compliant README JuliaSmoothOptimizers/JSOSolverSkeleton.jl
2 participants
@abelsiqueira @tmigot