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

Improve README for better clarity and understanding #15

Closed
axif0 opened this issue Oct 13, 2023 · 0 comments · Fixed by #16
Closed

Improve README for better clarity and understanding #15

axif0 opened this issue Oct 13, 2023 · 0 comments · Fixed by #16

Comments

@axif0
Copy link
Contributor

axif0 commented Oct 13, 2023

While going through the nx-parallel repository, I noticed that the README file could use a bit of sprucing up to make it even more helpful for newcomers.

These sections could be added and improved -

  1. Introduction
  2. Installation
  3. Usage
  4. Features
  5. Contribution
  6. Testing

I reckon these changes would make the README even better and more accessible to new users and contributors.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update README for Clarity and Comprehension axif0/nx-parallel
1 participant
@axif0