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

Basic documentation #11

Open
markusbaumeister opened this issue Mar 3, 2018 · 1 comment
Open

Basic documentation #11

markusbaumeister opened this issue Mar 3, 2018 · 1 comment

Comments

@markusbaumeister
Copy link
Contributor

Currently almost nothing is documented. For a rudimentary documentation the following aspects should be covered:
-> What kind of graphs are allowed?
-> How can graphs be constructed?
-> How can they be checked for isomorphism?

@sebasguts
Copy link
Collaborator

Usually, one wants a reference (providing some reference for all the commands in the package, and maybe some examples) and a manual, explaining the purpose of the package, and showing some of its capabilities in a larger context.

In this regard, one should start with a reference, and later adding a manual.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants