Skip to content

Move sketch to appropriately named subfolder #70

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

Closed
wants to merge 1 commit into from
Closed

Move sketch to appropriately named subfolder #70

wants to merge 1 commit into from

Conversation

per1234
Copy link

@per1234 per1234 commented Apr 1, 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 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 "esp8266-fastled-webserver.ino" needs to be inside a sketch folder named "esp8266-fastled-webserver".
Create this folder, move the file, and continue?

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

esp8266-fastled-webserver-master\esp8266-fastled-webserver\esp8266-fastled-webserver.ino:34:30: fatal error: GradientPalettes.h: No such file or directory

 #include "GradientPalettes.h"

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 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 "esp8266-fastled-webserver.ino" needs to be inside a sketch folder named "esp8266-fastled-webserver".
Create this folder, move the file, and continue?

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

esp8266-fastled-webserver-master\esp8266-fastled-webserver\esp8266-fastled-webserver.ino:34:30: fatal error: GradientPalettes.h: No such file or directory

 #include "GradientPalettes.h"
@jasoncoon jasoncoon closed this Jun 14, 2020
@per1234
Copy link
Author

per1234 commented Jun 14, 2020

@jasoncoon why did you close this? The problem still exists.

@jasoncoon
Copy link
Owner

I closed this issue because I won't be "fixing" it. You can either:

  • use git to clone the repo, in which case it'll clone it to a folder named esp8266-fastled-webserver, and this problem won't exist, or
  • use the download button to download the zip file, extract it to a folder named esp8266-fastled-webserver, and this problem won't exists, or
  • etc

@per1234
Copy link
Author

per1234 commented Jun 14, 2020

OK, well it's common courtesy and best practices to take a minute to write a short summary of the reasoning when closing a PR or issue.

@per1234 per1234 deleted the sketch_folder branch June 14, 2020 23:37
@jasoncoon
Copy link
Owner

Ah, sorry, got mixed up. I didn't actually close this pull request. It got closed automatically when I renamed the default branch from master to main a bit ago.

But, that aside, sorry, I'm not planning on merging this PR.

@per1234
Copy link
Author

per1234 commented Jun 14, 2020

Thanks for the clarification. I understand what happened now.

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