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

Missing files at repo or did get moved? #49

Open
develone opened this issue Jul 31, 2024 · 4 comments
Open

Missing files at repo or did get moved? #49

develone opened this issue Jul 31, 2024 · 4 comments

Comments

@develone
Copy link

I forked both pico-ice and pico-ice-sdk on 07/25/24.
At this time I created branches test-dev in both pico-ice and pico-ice-sdk.

pico-ice
commit 12eea82 (origin/main, origin/HEAD)
Author: Josuah Demangeon [email protected]
Date: Fri May 26 00:58:02 2023 +0200

pico-ice-sdk
commit 4ebe348ffcb4feb3e2756d101f594679eb02d97c (HEAD -> test-dev, origin/test-dev, origin/main, origin/HEAD)
Author: Josuah Demangeon [email protected]
Date: Thu Jun 20 23:12:41 2024 +0200

examples: ice_makefile_blinky: allow blinking with R, G or B easily

On 07/30/24 I noticed This branch is 88 commits behind tinyvision-ai-inc/pico-ice:main.
pico-ice/Docs
_config.yml ice_flash.md images pinout.md
favicon.ico ice_fpga.md index.md pmods.md
Gemfile ice_led.md learn.md programming_the_fpga.md
Gemfile.lock ice_spi.md LICENSE programming_the_mcu.md
getting_started.md ice_sram.md pico_ice_sdk.md
ice_cram.md ice_usb.md pinout

Now pico-ice/Docs
Doxyfile images pmods.md
doxygen-awesome-css index.md programming_the_fpga.md
DoxygenLayout.xml learn.md programming_the_mcu.md
favicon.ico pinout
getting_started.md pinout.md

This repo https://github.com/tinyvision-ai-inc/pico-ice/tree/main/Docs now is missing some very important files
needed for understanding the rp2040 functions with ice40UP5K.
I believe these are missing (ice_flash.md, ice_fpga.md, ice_led.md, ice_spi.md, ice_sram.md, and ice_usb.md).

I added several files in my test-dev branch in pico-ice/myDocs.
This should have said that I was ahead of tinyvision-ai-inc/pico-ice:main.

@josuah
Copy link
Collaborator

josuah commented Jul 31, 2024

Hello! The documentation evolved. Before, Sphinx was used (i.e. what ReadTheDocs uses). Now Doxygen is used, which permits to have the documentation for each of these features as part of the C source header themselves, and the HTML documentation is generated from here:
https://pico-ice.tinyvision.ai/modules.html

@josuah
Copy link
Collaborator

josuah commented Jul 31, 2024

Here is where you will find the same content as the ice_[...].md files you pointed at earlier:
https://github.com/tinyvision-ai-inc/pico-ice-sdk/tree/main/include

@develone
Copy link
Author

Thanks! Did the repo change just a few days ago? My 2 pico-ice boards were shipped. Looking forward to seeing how they work. Excited to start learning about this combo of rp2040 & ice40UK5K.

@josuah
Copy link
Collaborator

josuah commented Aug 1, 2024

It is possible that the firmware you receive on the pico-ice is not the latest one.
There are occasionally bugfixes published and a good precaution would be to download the latest release as soon as receiving the board, or indicate anyone using them to do so, in order to avoid confusing bugs that are already fixed:
https://github.com/tinyvision-ai-inc/pico-ice/releases/latest

There will be some changes to the repo, and the develop branch gets updated more frequently.
I do not remember the main branch being updated very lately.

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

No branches or pull requests

2 participants