hackclub / hackclub/sprig

[Spade] Documentation not being up to date causes issues during compilation

Open
#3,860 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
JavaScript
Stars
1.1k
Forks
1.8k
Avg merge
8d 12h
Merged PRs (30d)
12

Description

Documentation and scripts for Spade compilation are very outdated, and lead to issues.
Some places point to the old repository formatting , refresh.sh for rpi is not called anywhere, old libraries are said to be used when it won't compile at all if you use them with the recent code...

A documentation should help understanding code, and in this case how to compile the project, however it being very outdated prevents anyone to actually create something based on Spade's code.

I am kindly asking for a refresh of this documentation to allow curious programmers to implement their own features in Spade and allow them to compile their creation.

Thank you very much :>

Contributor guide

Open the contributing guide

Research direction

Start by locating the Spade compilation documentation and scripts, including refresh.sh for RPi. Check repository-format references, library requirements, and whether the Raspberry Pi script is called; done means the documented steps and scripts match the current code and allow a fresh compilation.

Written by the indexing model from the issue text.

Assessment

Tech stack
raspberry-pi
Domain
build-system, documentation, embedded-iot
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.