Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move program documentation to a separate file #19

Open
lnlp opened this issue Aug 19, 2021 · 0 comments
Open

Move program documentation to a separate file #19

lnlp opened this issue Aug 19, 2021 · 0 comments
Assignees
@lnlp
Labels
documentation Improvements or additions to documentation

Comments

@lnlp
Copy link
Owner

lnlp commented Aug 19, 2021 •
edited

Currently most of LMIC-node's documentation is contained in README.md.

The main purpose of README.md is to describe the purpose and contents of the repository however.
I should be possible to update README.md (e.g. for repository forks) without modifying any program documentation.

To make this possible program documentation will have to be moved to a separate file.
@lnlp lnlp added the documentation Improvements or additions to documentation label Aug 19, 2021
@lnlp lnlp self-assigned this Aug 19, 2021
@lnlp lnlp changed the title Move documentation to a separate file Move program documentation to a separate file Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lnlp lnlp

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lnlp