Code Monkey home page Code Monkey logo

Comments (6)

end2endzone avatar end2endzone commented on September 26, 2024

Regarding your specific error message, you seem to be having the same issue as this guy. You could try the suggestion and hope you can compile the code.

[EDIT] But I think it is unrelated if you use git clone instead of download github's zip file. (see comment below)

from win32arduino.

end2endzone avatar end2endzone commented on September 26, 2024

RapidAssit is already a submodule of win32Arduino. See the github code page for reference. You can see that googletest and RapidAssist are submodule and pointing to specific commits of their respective repository.

However, when you download the source code from github, the downloaded zip file does not contains the submodules but empty directories. In this case, you must manually download the specific version of RapidAssit and yes RapidAssist should be considered as dependency.

But if you used git clone to "download" the source code, then the appropriate version of RapidAssist should be automatically downloaded with git submodule update. In this case, the user should not have to deal with downloading a particular version of RapidAssist. Everything is done automatically. In this case, RapidAssist should not be considered as a dependency (IMHO).

I am having a hard time dealing with git submodules and (obviously) properly documenting the dependency section of install.md. Coming from subversion world, I am used to create "pointers to other commit of a repository" (called externals) in order to guide the user to know that a repository is "compatible" with another repository.

This should be clarified in the install.md documentation.

from win32arduino.

end2endzone avatar end2endzone commented on September 26, 2024

I propose to update install.md documentation as follow:

  1. Remove googletest from Software Requirements section. This is because googletest should be downloaded automatically (as a git submodule). As opposed to CMake, googletest does not requires to actually be "installed" before compiling.

  2. Create a Submodule dependencies section. Add googletest and RapidAssist specific version in this section. Both dependency should mention they are git submodule.

  3. The Install section should propose to "clone" an existing tags instead of "downloading" from the latest tag.

  4. The ending of the dependency section should state the following: "Note: submodule dependencies should be updated using git submodule update command. If the source code was downloaded, all submodule dependencies should be downloaded manually. Please make sure that downloaded version matches the version expected by win32Arduino."

I hope my explanation makes sense to you. What do you think ? Do you have a better proposition ?

from win32arduino.

sidey79 avatar sidey79 commented on September 26, 2024

With this proposed documentation it is much clearer i think.

from win32arduino.

end2endzone avatar end2endzone commented on September 26, 2024

I pushed a new commit (bfd8c11). This is a documentation update that should clarify new build instructions for Windows and Linux and remove ambiguity about submodules and dependencies. If should fix issue #21, issue #32 and issue #33. Please tell me if this change has resolved your issue and I will close it.

from win32arduino.

sidey79 avatar sidey79 commented on September 26, 2024

Wenn can close this issue. Thanks for clarify the dependencys.

from win32arduino.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.