Skip to content

convert README from md to rst#20

Merged
freakboy3742 merged 2 commits into
beeware:mainfrom
TShDaub:convert-readme-19
Jul 20, 2025
Merged

convert README from md to rst#20
freakboy3742 merged 2 commits into
beeware:mainfrom
TShDaub:convert-readme-19

Conversation

@TShDaub

@TShDaub TShDaub commented Jul 20, 2025

Copy link
Copy Markdown
Contributor

Fixes #19.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@freakboy3742 freakboy3742 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - a couple of minor tweaks inline

Comment thread README.md Outdated
A [Cookiecutter](https://github.com/cookiecutter/cookiecutter/) template
for building Python apps that will run as statically-served web pages

# Using this template

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Using this template
## Using this template

Comment thread README.md Outdated

$ python -m httpd.server --directory www

# Next steps

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Next steps
## Next steps

Comment thread README.md Outdated
$ cookiecutter https://github.com/beeware/briefcase-web-static-template

This will ask you for a number of details of your application,
including the <span class="title-ref">name</span> of your

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The <span> tags here (and elsewhere) aren't a problem, but they aren't adding anything either - so for the sake of simplicity, we might as well remove them.

@freakboy3742
freakboy3742 merged commit bf85867 into beeware:main Jul 20, 2025
4 checks passed
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.

Convert README.rst from reStructuredText to GitHub-flavored Markdown

2 participants