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

Updated README.md file #493

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Updated README.md file #493

wants to merge 9 commits into from

Conversation

randolj
Copy link

@randolj randolj commented Oct 2, 2023

  • Made the introduction explanation to ttkbootstrap more detailed while remaining concise.
  • Created a documentation section to make it stand out to new users.
  • Added a short explanation to the installation section for newer developers.
  • Added small explanations for the code and how to import the library and what the different lines of code do.
  • Added an image for what the desired result of the code should be.
  • Added a link to the getting started page of the documentation and what users would find there.
  • Added a Contributing section, all that is missing is a contributing file for contribution guidelines.

- Made the introduction section a bit longer but kept it consice.
- Added a longer explanation to the pip install section.
- Made a section just for the documentation section to make it more prominent and encourage new users to visit the site.
- Added explanations for what the commands in the getting started section do.
- Added a screenshot of what the desired result from the getting started section is.
- Added a contributing section but just need to include actual contribution section.
- Added a space to separate the documentation part from what comes after
- Added some more details to the getting started section
This image is used in the getting started section to show what the desired output of the code should be.
Edited the image to get from my github repo page
Updating README image of result
Editing format of image added
Continuing to fix formatting
Editing formatting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant