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.

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

Move sketch to appropriately named subfolder #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

per1234
Copy link

@per1234 per1234 commented Apr 29, 2018

The Arduino IDE requires that a sketch be located in a folder of the same name. Although the name of the repository does match the sketch name, when GitHub's popular Clone or download > Download ZIP feature is used to download the contents of a repository the branch/release/commit name is appended to the folder name, causing a mismatch.

When opening a file that does not meet this sketch/folder name matching requirement the Arduino IDE presents a dialog:

The file "TWANG.ino" needs to be inside a sketch folder named "TWANG".
Create this folder, move the file, and continue?

After clicking "OK" the Arduino IDE currently moves only the file TWANG.ino to the new folder, leaving behind the other source files. This causes compilation of the sketch to fail:

TWANG-master\TWANG\TWANG.ino:7:18: fatal error: iSin.h: No such file or directory

The Arduino IDE requires that a sketch be located in a folder of the same name. Although the name of the repository does match the sketch name, when GitHub's popular Clone or download > Download ZIP feature is used to download the contents of a repository the branch/release/commit name is appended to the folder name, causing a mismatch.

When opening a file that does not meet this sketch/folder name matching requirement the Arduino IDE presents a dialog:

The file "TWANG.ino" needs to be inside a sketch folder named "TWANG".
Create this folder, move the file, and continue?

After clicking "OK" the Arduino IDE currently moves only the file TWANG.ino to the new folder, leaving behind the other source files. This causes compilation of the sketch to fail:

TWANG-master\TWANG\TWANG.ino:7:18: fatal error: iSin.h: No such file or directory
@mirceaciu
Copy link

just remove the -[branch name] appended to the root directory

@per1234
Copy link
Author

per1234 commented Oct 2, 2018

@mirceaciu ...or just put the sketch in an appropriately named folder and that won't be necessary.

Of course I know to change the folder name. The purpose of this PR is to make the project friendly to the average Arduino user, who won't know to do that and will end up suffering a lot of confusion. That also results in an increased support burden.

@mirceaciu
Copy link

.ino file must have same name as root folder. If your 'average' user does not know this fact he will probably have bigger problems when importing the project dependencies. Let them learn, it better this way

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants