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

README needs updates #4

Closed
fingolfin opened this issue Feb 11, 2025 · 2 comments
Closed

README needs updates #4

fingolfin opened this issue Feb 11, 2025 · 2 comments

Comments

@fingolfin
Copy link
Member

Some issues with the README that should be resolved before it gets added to the GAP package distribution:

  1. the package name is capitalized as "ibnp" here, but in the manual and in PackageInfo.g it is "IBNP"
  2. Incomplete Introduction:
## Introduction

This package allows for ...  

  1. "History" section redundant given that there is a CHANGES.md file? In any case they clash
  2. use of http links instead of https
  3. don't use {\copyright} -- either use unicode © or approximate it with (c) or (my personal favorite) just omit it

There might be more but I'll stop here for now. I am happy to have a fresh look once you had a chance to overhaul it :-)

@cdwensley
Copy link
Collaborator

All five issues dealt with.

@cdwensley
Copy link
Collaborator

Finally resolved by PR #10

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