Restructured project to work as library

[FernandoGarcia]

Hi!

I have restructured the project to make it work as library.

I have tested using your example and works perfectly.

To test just copy the files to lib folder of a newly created PIO project then copy example files to src folder and ini files to root of the new project.

For now I think it won't pass in CI build because is needed adjust the action file.

After you can make a manifest and publish your project in PIO library repository.

Best regards.

[Eisbaeeer]

Please merge this pull-request. It will be great to use it as a lib.

[rjwats]

I agree it's a good goal! I'd like to support it as both an Arduino and PIO library for sure. Changing the structure of the project as suggested would mean tricky merges for those who use have forked the repository for their own projects though so that needs to be considered too. Comitting the generated artefact (WWWData.h) to the master branch in source control after every rebuild of the UI doesn't feel like the ideal way to go about it either. It's effectively text-encoded binary, there is no useful diff as such, also the artefact is reasonably large. What about this idea... Store the ui artefact (WWWData.h) for versioned releases only in SCM. Doing this by pushing the library releases to another repository which serves as a library-only mirror of the main repository. Thoughts on this approach?

…

On Mon, 21 Mar 2022, 19:48 Lars Weimar, ***@***.***> wrote: Please merge this pull-request. It will be great to use it as a lib. — Reply to this email directly, view it on GitHub <#281 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKE4VBE74NZIQXS434KXULVBDHAXANCNFSM5QZIW4GQ> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[FernandoGarcia]

Hi!

"Changing the structure of the project as suggested would
mean tricky merges for those who use have forked the repository for their
own projects though so that needs to be considered too."

I don't think it's a big problem since just will be needed move the files to lib folder.
Also looking to dependency graph doesn't exists a single project using this framework as dependency.

Comitting the generated artefact (WWWData.h) to the master branch in source
control after every rebuild of the UI doesn't feel like the ideal way to go
about it either. It's effectively text-encoded binary, there is no useful
diff as such, also the artefact is reasonably large.

If user want use the project as it's, giving the compiled file will exclude the needed to install npm and save compiling time.
Moreover to Arduino IDE users I think will be impossible to build the UI just using the IDE.

What about this idea...

Store the ui artefact (WWWData.h) for versioned releases only in SCM. Doing
this by pushing the library releases to another repository which serves as
a library-only mirror of the main repository.

Well, it's your project do you know what's the best way to manage the project according to your availability.

Best regards.