Comments (7)
It was my pleasure contributing! I will also keep an eye here because I'm interested on this topic.
from qr-scanner-cli.
I took the liberty of updating the readme file with two minor changes:
- Added how to get help from the command line ( I had to look over
meow
docs and also a bit of playing around to get that) - Added a disclaimer instructing the user that the options described on the readme
may
be outdated.
I believe with this two minor altercations you can get rid of updating this part of the readme for a time now.
from qr-scanner-cli.
Thanks again @mrcehlo, I'll keep this issue opened if anyone find any improvement on that.
from qr-scanner-cli.
@victorperin I don't think this is possible by any kind of markdown on readme file, but following some opened issues on github with this very same request, I've got this gem that maybe could be of use.
Of course, you would need to setup a hook in order to run the helper, the helper would then update your Readme file based on your class and now you would get an updated readme file.
Not as automatically as I would like, but it is something :)
helper> https://rubygems.org/gems/markdown_helper
repo> https://github.com/BurdetteLamar/markdown_helper
from qr-scanner-cli.
Hello @mrcehlo, thanks for this.
Ok, I need to do some research on it for JS (or maybe could be something to build another package for
Tomorrow I'll look into it, If you find sometthing good, please respond here. And If you think this has good enough quality, you can build a PR :)
from qr-scanner-cli.
@victorperin
Thinking about it, perhaps we are looking into it from the wrong perspective.
Wouldn't it be better if we show the path to find the updated options instead of writing it on the Readme?
In this way, instead of showing the options, we would show the command argument to get the options on the terminal:
> Options
qrscanner /?
qrscanner --help
Find all available options in helpText.js
from qr-scanner-cli.
I found this package: @appnest/readme
I think this this fits all requisites and can automate this process of documenting.
from qr-scanner-cli.
Related Issues (20)
- An in-range update of jimp is breaking the build 🚨 HOT 5
- An in-range update of eslint-config-airbnb-base is breaking the build 🚨 HOT 1
- An in-range update of coveralls is breaking the build 🚨 HOT 1
- An in-range update of ts-node is breaking the build 🚨 HOT 3
- An in-range update of eslint-config-prettier is breaking the build 🚨 HOT 1
- An in-range update of @typescript-eslint/eslint-plugin is breaking the build 🚨 HOT 3
- An in-range update of @typescript-eslint/parser is breaking the build 🚨 HOT 3
- CI: move from Travis-CI to GitHub Actions
- Stytle: use Typescript Standard configuration on eslint
- Style: start linting tsdoc
- Feature: [Programatic] read from bitmap HOT 1
- Automatic build documentation
- html TypeDoc publishing
- Documentation: order functions before types
- Move from meow to an alternative HOT 1
- Using --clean doesn't work HOT 2
- Tests: Fix all surviving mutations HOT 1
- Check support for ESM and CJS
- [BUG] parsing bug (probably a regresson?) HOT 4
- Cannot read properties of undefined (reading 'includes') HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from qr-scanner-cli.