Feature Documentation

[JWally]

@bchevalier,

Would you be up for helping me better document this library's functionality? No rush at all, but I haven't done a great job of documenting what is in this library or how to use it very well. I figure we can kick around what all to include in this thread until we're comfortable moving over pieces to the readme.

For instance, I think you've made it possible to have free-variables (no 0 floor), but I'd have to dig in the tests on how to use it.

So here's my first pass at an outline:

• What is the library, what does it do?
• Explanation of model parts (opType, variables, int, etc)
• Function API
• (Alt) Input Styles
  • Object Model
  • Text File
  • Array
• Other Functionality
• Examples (?)

Again, I'm in no rush to get this done, but I think a good documentation would be useful. Thoughts?

[bchevalier]

I also think that would be a good idea to improve the documentation. I am not so available these days, it will be a couple of months before I involve myself in the documentation.

[lvenerosy]

I would like to do some modifications on the documentation to make people understand more quickly what is jsLPSolver and to help contributors :

• quick introduction on mixed integer linear problems (with a few words on the simplex and branch and cut)
• a few study cases (like the knapsack)
• better examples to display linear problems and mixed linear problems
• both the JSON version and the API version for these problems
• a few intermediate instances in the tens of variables/constraints
• a class diagram
• a flow chart of a problem solving from the user input to the solution

@JWally, Any advice or anything to prioritize ?

[JWally]

@lvenerosy, this is all great! Whatever you feel like working through first, I'm good with.

The only request would be that if you modify the readme, try and keep the intro and "getting started" section gentle so that a non-mathemagician's eyes don't glaze over :P. After that, please feel free to go to town!

[JWally]

btw, @lvenerosy; would you like me to list you as a contributor? If so, let me know how you want in there.

Thanks again!

[lvenerosy]

@JWally, yes that would be nice thank you.