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

Revisit README.md to make overview sections more relevant #468

Open
braddf opened this issue Feb 13, 2024 · 1 comment
Open

Revisit README.md to make overview sections more relevant #468

braddf opened this issue Feb 13, 2024 · 1 comment

Comments

@braddf
Copy link
Contributor

braddf commented Feb 13, 2024

Part of transitioning this repo from original "meta-repo" for the nowcasting project to a more frontend-focused repo.

Detailed Description

At present, the sections of the README relating to the rest of the OCF codebase, e.g. ML, are written in general project terms from the birds-eye perspective of OCF, which potentially reads slightly oddly for what is otherwise purely a repo containing code for apps. Hopefully we can keep the overview, but make more relevant and sensible for any Typescript-types that stumble across this repo and would like to contribute, to give them a good quick-start on how/what goes on at OCF.

@braddf braddf added the enhancement New feature or request label Feb 13, 2024
@peterdudfield peterdudfield removed the enhancement New feature or request label Jul 16, 2024
@peterdudfield
Copy link
Contributor

It feels like a lot of the readme is still not needed. I know this is copied over from the meta repo

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