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

Feature doc #4

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Conversation

yoannkubera
Copy link

Designed the markdown documentation.
Also identified issues related to the execution.

Additions

  • CHANGELOG.md and CONTRIBUTING.md files, doc/ dir
  • Markdown preview script 'doc/preview.py'
  • Written a base Readme.md file as well as base usage information

What's missing

  • The contents of the LICENSE file ;
  • In the Readme.md file :
    • Replace the "TODO" text by the name of the license in the corresponding badge ;
    • Replace the "TODO" text by the required version of c++ in the corresponding badge ;
    • Replace the "TODO: General description of the project" text by the actual description of the project ;
    • ? Include an acknowledgement related to LGI2A / Artois university in the "Acknowledgements" section ?
    • Check that the command line to run the example is apporpriate (./build/main -i data/CVRP/toy.vrp) ;
    • Fill in the supported versions for gcc / g++ and CMake
  • Replace logo.svg by a better logo
  • In the doc/options.md file :
    • Write the content of the file
  • In the doc/usage.md file :
    • Check the validity of the information in the "Presentation" section ;
    • Fill in the documentation for the "Instances", "Reader" and "Problem" sections.
  • A new file doc/solver.md in the documentation, telling when and how to create a solver, and how to test it
  • Inclusion of a link towards that documentation file in the readme.

Issues

The actual command running the solver could not be assessed because the compilation failed on the target system.
See the issue 3 for more information.

@sohaibafifi sohaibafifi self-assigned this Jul 23, 2021
@sohaibafifi sohaibafifi added the documentation Improvements or additions to documentation label Jul 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants