search

Living-with-machines / lwmdb

A django-based library for managing the Living with Machines newspapers metadata database schema
https://living-with-machines.github.io/lwmdb/
MIT License
2 stars 0 forks source link

Remove "$" from bash commands in readme instructions #86

Closed rwood-97 closed 1 year ago

rwood-97 commented 1 year ago

Currently it copies as $ git clone git@github.com:Living-with-machines/lib_metadata_db.git which gives: zsh: command not found: $ if pasted into terminal.

kallewesterling commented 1 year ago

This actually follows the standard for writing bash commands in documentation on GitHub. It's annoying, but it looks like the organisation are making strides to change this:

See https://github.com/orgs/community/discussions/35615

rwood-97 commented 1 year ago

Mmm okay, I guess we wait for GitHub to fix this then.

griff-rees commented 1 year ago

Thanks both. @rwood-97: I've also had this frustration, especially for long, complicated commands. I've gone back and forth. I've (of late) erred on the side of readability over ease, but it is quite annoying, will mull this.

The link is quite helpful @kallewesterling, think I'll keep that for future chats of this ilk. I'm wondering settling the copy click event to skip the $ ends up being the solution.

kallewesterling commented 1 year ago

The link is quite helpful @kallewesterling, think I'll keep that for future chats of this ilk. I'm wondering settling the copy click event to skip the $ ends up being the solution.

Yeah, I think it's something like this that they're planning to implement, but that's nothing that we can do on our end. GitHub's markdown only allows for certain things (not even styling/formatting) so we'll just have to stand by here, I think...

griff-rees commented 1 year ago

Thanks both. Should be addressed as of the merge to main of d7ca59b210812a279e50cf8c03e4d944004935e8