Add a "getting started" guide.
See original GitHub issueI’m looking for something to help automate the release of various libraries I write, so something that would bump versions automatically, commit and push tags, generate changelog etc would be great, but I can’t for the life of me figure out how to use this project. I’ve gleaned some information from the various documentation, but when I run semantic-release version
it keeps telling me it won’t make a new release.
A “getting started” guide with a few steps for how to try this tool out would be very nice.
Issue Analytics
- State:
- Created 8 years ago
- Reactions:4
- Comments:10 (6 by maintainers)
Top Results From Across the Web
How to Write a Getting Started Guide - DocumentWrite
A Getting Started guide is one of the most important pieces of documentation that helps your users build trust with your product or...
Read more >1. Welcome to Getting Started User Guide - Oracle Help Center
1. Welcome to Getting Started User Guide. The Getting Started User Guide helps you get started with Oracle Banking applications. This user guide...
Read more >10 Tips for Creating Quick Start Guides - Make it Clear
10 tips for creating quick start guides · 1. Identify the objective(s) · 2. Show don't tell · 3. Define the scenarios ·...
Read more >How to Create a Comprehensive How to Guide [+Examples]
A well-crafted how-to guide can: Support curious and frustrated customers; Offer 24/7 access to help; Engage readers; Anticipate user needs. How ...
Read more >Getting Started Guide | Segment Documentation
Welcome to Segment! This doc mirrors Segment's in-product guide, and walks you through each of the tasks to level up your workspace strength ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Any updates on this? I have troubles getting started with this tool on a new project, since whatever command I run, I get errors.
I would like some basic instructions like:
Do I need to specify the version variable reference in a
pyproject.toml
? Or will it create a separate file to store the version by default? I would have expected the latter, but if I have to put it in a Python file, that’s fine.What tags need to exist? Do I have to have a
v0.0.1
tag to begin with?Perhaps this can be added to the README.
Thanks!
@slhck I updated the readme hope it helps. If not please re-open the issue and add some notes about what is hard to understand or where you are stuck.