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.

Sign up for GitHub

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

Jump to bottom

Add a great README #3

Open
jankapunkt opened this issue Mar 20, 2020 · 3 comments
Open

Add a great README #3

jankapunkt opened this issue Mar 20, 2020 · 3 comments
Assignees
@jankapunkt
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jankapunkt
Copy link
Member

jankapunkt commented Mar 20, 2020 •
edited
Loading

We want for this repo a great readme as entry point for development of the lea.online projects.
We should follow the guides for great README files:

https://github.com/matiassingers/awesome-readme

Beyond the developer-centric content from the README we need to address the following issues:

  • introduction to lea.online
  • high level system overview for non-technical persons
  • DEMO / Staging environment and how to get involved in development with us
  • funding note (BMBF FKN etc.)

Related PR #4 is considered "in progress" until the "work in progress" label has been removed

@kadewe @ImkeMey do you have suggestions what you want to include to the readme?
@jankapunkt jankapunkt self-assigned this Mar 20, 2020
@jankapunkt jankapunkt added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 20, 2020
@jankapunkt jankapunkt mentioned this issue Mar 20, 2020
Merged
@ImkeMey
Copy link
Member

ImkeMey commented Mar 23, 2020 •
edited
Loading

what do you mean with "Introduktion to lea.online"? Just a quick overview? I think it we should give an insight into the project goals, the background and the target group. Since this is necessary to understand some of our specifications, it should be explained in the readme. But maybe you came up with that yourself already :-)

@jankapunkt
Copy link
Member Author

@ImkeMey that's exactly what I intended to provide with such an introduction 👍

@ImkeMey
Copy link
Member

ImkeMey commented Mar 23, 2020

perfect!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jankapunkt jankapunkt

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jankapunkt @ImkeMey