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

Add proper README.md #99

Open
maxgerhardt opened this issue Jan 17, 2023 · 2 comments
Open

Add proper README.md #99

maxgerhardt opened this issue Jan 17, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@maxgerhardt
Copy link
Collaborator

This project repository lacks a proper representative README.md that would give users much needed insight on what this repo is without vising other websites.

@maxgerhardt maxgerhardt added the enhancement New feature or request label Jan 17, 2023
@maxgerhardt maxgerhardt self-assigned this Jan 17, 2023
@maxgerhardt maxgerhardt added the documentation Improvements or additions to documentation label Jan 17, 2023
@Florin-Popescu
Copy link

Florin-Popescu commented Feb 8, 2023

Hi!

Partly related, the README in my fork documents some steps on how to extend the project in the future. Would that be good to include in the readme here or in some other file? I would like to delete my fork after everything is upstreamed here, and I think I've gathered some really good information in there that should be saved in here.

@dl8dtl
Copy link
Collaborator

dl8dtl commented Feb 8, 2023

I think this would be more suited for an issue tracker or discussion item type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants