question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Update the Build Procedure in README.md

See original GitHub issue

As a first time contributor to the Conda-forge, the contributor would be reading the Build Procedure in Readme.md file, at first. Hence the steps that are to be taken to set the project in the local environment as well as to do lists before sending the PR should be mentioned clearly.

clear steps/tutorial links can be provided to let the contributor know how to get familiar with sphinx. For example: sphinx Docs

This can be followed by steps mentioned above. In addition before sending PR the contributor should check the changes made in src folder works well by verifying the docs file in their local directory.

(open command prompt=> sphinx-build . ../docs =>auto generated html file in docs folder can be found)

These steps are not mentioned below:

Screenshot (88)

Issue Analytics

  • State:open
  • Created 2 years ago
  • Comments:9 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
prachi237commented, Apr 1, 2021

@beckermr and @viniciusdc what do u think about this? shall I add these steps that I mentioned above to make the docs more user-friendly.

1reaction
beckermrcommented, Apr 1, 2021

Yes please!

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Create a Self-Updating README.md for Your GitHub ...
Clone the repository to your computer and open a terminal to its directory and create a new npm project. We are going to...
Read more >
Managing your profile README - GitHub Docs
Above the right sidebar, click Edit README. The generated README file is pre-populated with a template to give you some inspiration for your...
Read more >
Can github actions edit parts of README.md? - Stack Overflow
I figured it out. You can it manually by using the sed command in bash within a runner in github actions. Set your...
Read more >
README.md template | Documenting your project - Drupal
Modules upgrading to Markdown formatting should adjust their README files to match Markdown features. Headers in README.txt -files were all upper-cased to make ......
Read more >
Make a README
Learn how to make a great README for your programming project, and use the editable template to get started.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found