Comments (13)
Of course, README.md should contain only description. I'm against copy-pasing text like:
to install write:
...
to uninstall write:
...
I think that:
For more information on `oh-my-fish` visit ...
would be enough. This text is easy to append automatically by script to all plugins.
from oh-my-fish.
I'd prefer using git tags instead of branches, this way plugins can be versioned using semver.
from oh-my-fish.
But I definitely like omf info
command and your proposed output!!
from oh-my-fish.
I'd prefer using git tags instead of branches, this way plugins can be versioned using semver.
You are right. I meant tags, not branches. I'll fix it.
from oh-my-fish.
I believe I didn't understand the proposal for the README file. Could you try explaining again?
from oh-my-fish.
@bpinto
Well. Printing markdown to a console output is not a very good idea.
I actually vote for self-documented code, so I think that after implementation of fish-shell/fish-shell#478 we can just simply build README files from the help. So, for now, I would leave README files as they are.
BTW, it's possible to extract repository description from .git/description
file.
I've changed proposal again.
from oh-my-fish.
I can see this working as it was proposed, might be interesting to see what current plugins would output.
from oh-my-fish.
See also git describe
to generate a version, which relies on annotated tag.
from oh-my-fish.
I usually use git describe --tags --always HEAD
from oh-my-fish.
@rominf are you working on a PR for this?
from oh-my-fish.
@bpinto, no.
from oh-my-fish.
This will be marked as solved as part of the effort in #427.
from oh-my-fish.
#427 is merged. Packages can now be grouped, be more discoverable, and have metadata using the new package repository system built on top of Git. Closing as solved.
from oh-my-fish.
Related Issues (20)
- How can I uninstall completely oh my fish? omf destroy does not uninstall omf HOT 7
- ctrl+a, ctrl+b are not working after OMF installed HOT 8
- Installation failure from curl on Pop-os HOT 4
- 'omf install powerline' responding with "Please install powerline" and not being usable HOT 1
- Is this project active? HOT 2
- Installer checksum in README.md isn't up to date.
- Print error: failed to parse choice argument: 2- HOT 2
- Cannot omf update or install packages
- All plugins
- Z
- OMF's offline installation doesn't really work offline
- Theme not updating even after using command for theme change.
- This no longer supports Fish 2.2.0
- Can't change the theme HOT 1
- I just install OMF and installed the cyan theme and this happened HOT 2
- I see a `[I]` in my fish! HOT 2
- oh-my-fish crashes Garuda-Update process HOT 2
- Remove [I] in the prompt HOT 1
- Installer does not check `$OMF_PATH` permissions
- Prompt Encoding as Question Mark HOT 2
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 oh-my-fish.