JasinskiSz / resuto-manager

1 stars 0 forks source link

Task: Create GitHub Readme File #8

Open JasinskiSz opened 4 months ago

JasinskiSz commented 4 months ago

Task Title

Task: Create GitHub Readme File

Description

Readme file should be created to introduce anyone into the project. This allows me to share my knowledge and my perspective. It can also be beneficial when showcasing a project on the portfolio.

Acceptance Criteria

A complete README.md file with proper sections.

Definition of Done

As bare minimum the file:

must be properly named and be of a markdown extension
it has to contain sections:
- "how to run" or equivalent
- "demo" showcasing video or screenshots
- "tech stack"
- "authors"
- "overview"

This can be changed, so it's TBD

amanreddy77 commented 4 months ago

hey @JasinskiSz i will do this assign this to me

JasinskiSz commented 4 months ago

Hi, @amanreddy77!

I'll just add the license to the project in the meantime, but you can go on with the readme. I'll review the PR after license is added.

Actually, before you start writing, do you have an idea for that? I mean I have came up with the project so it lives for now in my head and I can later find some time to describe it. Do you want to provide a skeleton for the readme or do you have a better, more comprehensive idea for it?

Let me know and many thanks to take interest in my project!

amanreddy77 commented 4 months ago

great! you provide me with a skeleton of the readme, if any changes or modifications required I will do it

JasinskiSz commented 4 months ago

great! you provide me with a skeleton of the readme, if any changes or modifications required I will do it

I meant to ask what's your idea for that task? I'm not sure anyone except myself can do it unless it's already coded and have some form – but it doesn't. It has shape in my head, but that would require me to do describe it.

I think what you can do to contribute and help me is to prepare a well thought-out template for the readme, so I can fill it up after. That's why I asked for your input on the idea for this task :) Other than that I think you could rewrite this issue to be more descriptive or provide additional context. I have it marked with "to be described" label because I did not do that properly and just gave it a simple base.

amanreddy77 commented 4 months ago

yeah i got it