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

Revamp README with project information #110

Closed
jspenger opened this issue Apr 24, 2023 · 5 comments
Closed

Revamp README with project information #110

jspenger opened this issue Apr 24, 2023 · 5 comments
Labels
discuss Discussion encouraged itype:documentation Improvements or additions to documentation stat:waitingnextrelease Issue with actions for next release
Milestone
alpha

Comments

@jspenger
Copy link
Member

The README is lacking project information. There should be general information about the project, the project status, and a comparison to relevant other projects. This should be done close to / before the release.
@jspenger jspenger added itype:documentation Improvements or additions to documentation discuss Discussion encouraged stat:waitingnextrelease Issue with actions for next release labels Apr 24, 2023
@jspenger
Copy link
Member Author

Information to include (structure inspired from https://github.com/phaller/spores3):

  • Introduction: Information, description
  • Project status; project plan
  • Add to your project: description on how to add it to project
  • Overview: some code examples of what this library is about
  • Project structure / team structure
  • Comparison to other projects

@jspenger
Copy link
Member Author

Other projects to compare to:

@jspenger
Copy link
Member Author

Additionally: add disclaimer that this project is a research product for the moment.

@jspenger jspenger added this to the 0.1.0 milestone May 8, 2023
@jspenger
Copy link
Member Author

jspenger commented Jul 5, 2023

  • Mark unfinished things as experimental, etc. explain this dichotomy in the readme.
  • Roadmap: about planned / not yet released features: Atomic Streams; FT; ...

@jspenger jspenger removed this from the 0.1.0-RC1 milestone Jul 7, 2023
@jspenger jspenger self-assigned this Jul 7, 2023
@jspenger jspenger added this to the alpha milestone Jul 7, 2023
@jspenger jspenger mentioned this issue Jul 10, 2023
Merged
@jspenger
Copy link
Member Author

The Readme has now been revamped (see #217 , #218). An issue was created to fix the outstanding task with comparison to other projects, which is not the highest priority at the moment. Thus, for these reasons, closing this task as completed.

@jspenger jspenger removed their assignment Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discuss Discussion encouraged itype:documentation Improvements or additions to documentation stat:waitingnextrelease Issue with actions for next release
Projects
None yet
Milestone
alpha
Development

No branches or pull requests
1 participant
@jspenger