Add README and MIT license - #2
Open
ecomodeller wants to merge 1 commit into
Open
ecomodeller wants to merge 1 commit into
ecomodeller wants to merge 1 commit into
Conversation
The repo had neither, so a visitor saw a bare file tree of docs/, tutorials/ and .fem data with nothing explaining what any of it is, and no license meant none of it could legally be reused. The README is deliberately short: what the repo is, a link to the documentation site it builds, and the point most likely to confuse a newcomer — that the ifm package itself ships inside FEFLOW and is not what this repository contains. The maintainers should extend it. MIT matches mikeio1d, modelskill, tsod and terracotta. It covers the documentation, tutorials and examples here only; the README says so explicitly, so it cannot be read as licensing FEFLOW or the ifm package. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found during a hygiene sweep of the org's public repos:
ifmwas the only public DHI repo with no README at all, and it had no license either. With 20 stars and 5 external forks, it's also one of the more visible.What this adds
README.md— deliberately short. What the repo is, a link to https://dhi.github.io/ifm/, and the thing most likely to confuse a newcomer: that theifmpackage itself ships inside FEFLOW and is not what this repository contains. Left as a stub on purpose — the maintainers know this material far better and should extend it.LICENSE— MIT, matchingmikeio1d,modelskill,tsodandterracotta.The README states explicitly that the license covers the documentation, tutorials and examples in this repo only, and that FEFLOW and the
ifmpackage remain proprietary DHI software. That wording is worth a careful read, since it's the part with legal weight.Separate issue
The published docs link twice to
DHI/ifm_contrib, which is now private and archived — those are 404s for anyone reading the site. Filed separately.🤖 Generated with Claude Code