Skip to content

Some proposed improvements to the readme - #25

Merged
josephsl merged 8 commits into
nvdaaddons:masterfrom
XLTechie:LDReadmeImprovements2023A
Mar 16, 2023
Merged

josephsl merged 8 commits into
nvdaaddons:masterfrom
XLTechie:LDReadmeImprovements2023A

Conversation

@XLTechie

Copy link
Copy Markdown
Member

The following commits present some proposed improvements (in my opinion) to the readme.

  1. Wherever bolding markdown was used to designate file names, folder names, or the like, I have changed these to code markers. In the future, it may be useful to also add quotes to some of them, but I didn't want to do that here.
  2. Added some code markers around file/folder names which lacked any kind of distinctive markdown.
  3. Added a note to the end of the Requirements section, about using cloud based build environments instead of local building.
  4. In section "To create a new add-on using this template": inserted a new step 3, instructing what to copy for workflows usage. Also separated the files/folders to copy into blocks of code markers, to make them easier to copy and paste.
  5. Also in section "To create a new add-on using this template": I merged steps 4 and 6, which were redundant. Note that before the previous change, these were steps 3 and 5.
  6. Corrected the path of the workflows folder.
  7. Updated the copyright, and made a couple minor grammar/punctuation corrections.

Luke Davis added 8 commits March 13, 2023 02:46
…orkflows" from ".github/workflow". Added code tags around path.
* Replaced current formatting in step 2, with code markers around file names.
This should make copy-paste operations more straight forward, as opposed to the narrative format used previously.
* Add a new step 3, instructing what to copy for workflows usage.
…, switched to code markers around filenames in more places, and merged steps 4 and 6 since they were redundant.
@XLTechie
XLTechie force-pushed the LDReadmeImprovements2023A branch from 593c163 to ca9a518 Compare March 13, 2023 07:04
@josephsl
josephsl merged commit b60c19c into nvdaaddons:master Mar 16, 2023
nvdaes pushed a commit to nvdaes/AddonTemplate that referenced this pull request Apr 20, 2026
nvdaaddons#25)

Bumps the uv group with 1 update in the / directory: [requests](https://github.com/psf/requests).


Updates `requests` from 2.32.5 to 2.33.0
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](psf/requests@v2.32.5...v2.33.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-version: 2.33.0
  dependency-type: direct:production
  dependency-group: uv
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@nvdaes nvdaes mentioned this pull request Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants