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

Contrib folder explanation #414

Merged
merged 2 commits into from
Jun 24, 2019
Merged

Contrib folder explanation #414

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d6e0ad
Added contrib folder explanation
makew0rld May 18, 2019
d468791
Fixed to DD2k's definition
makew0rld Jun 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ The software also supports Debian running on x86 and x64 boards, and many board

During the installation, you may be able to pick a profile, or choose between many modules. To learn what each module is for, look at [MODULES.md](./docs/MODULES.md). This is important for the installation.

There are some more experimental, 3rd party, or not fully supported modules in the [contrib](./contrib) folder for you to explore. Run those scripts with caution.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Contrib folders are not normally defined as they are a standard in many projects

What is the contrib folder:

It is for software that has been contributed to the project, but which might not actually be maintained by the core developers. Naming it "contrib" or "Contrib" is a long established convention.

In our case many of the scripts augment existing modules for specific task, and may need guidance to use. At present they are not documents at all.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will change my definition to the one you quoted.


## Check Status

1. Give the Pi about 15 seconds to reboot and SSH back into it. You should find the status of your mesh node automatically printed. You can also print this anytime by running `status`.
Expand Down