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

Clarify distinction between README and README.md #35

Open
fingolfin opened this issue Mar 19, 2018 · 2 comments
Open

Clarify distinction between README and README.md #35

fingolfin opened this issue Mar 19, 2018 · 2 comments

Comments

@fingolfin
Copy link
Member

It's not clear to me why there are both a README and a README.md file. Perhaps the intention is to merge the two? Then this should be recorded somewhere (e.g. this issue ;-).

Or perhaps they are meant to stay in parallel, which is also fine. But then I'd point from README.md to README. And I'd consider renaming README to e.g. NOTES or INTERNALS or whatever (and perhaps also convert it to Markdown?)

@olexandr-konovalov
Copy link
Member

README is the old file by the initial authors. README.md new, created when work on the package was started. Agree that this requires some revision!

@fingolfin
Copy link
Member Author

From the looks of it, I think a big part of README should actually be put into the package manual. The rest can be merged into README.md

HereAround added a commit to HereAround/ToricVarieties_project that referenced this issue Aug 12, 2021
HereAround added a commit to homalg-project/ToricVarieties_project that referenced this issue Aug 12, 2021
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