Readme should teach people about `tangle-mode` option

mtekman / org-tanglesync.el

A package to pull external changes into an org-mode source block if that block is tangled to an external file

GNU General Public License v3.0

90 stars 7 forks source link

Readme should teach people about `tangle-mode` option #2

Closed mankoff closed 5 years ago

mankoff commented 5 years ago

This is a good package. But to help people avoid this conflict, your README should teach people about tangle options :comments link :tangle-mode (identity #o444) which makes the tangled files read-only and provides links back to the source. This significantly reduces the chance of editing the tangled file by mistake, instead of the Org source.

mtekman commented 5 years ago

Thanks @mankoff! I added a commentary section to the README. Is that okay?