Trying to improve the documentation it's the first step needed for someone stepping into the project.
Details
Details
Diff Detail
Diff Detail
- Repository
- R4 Zanshin
- Lint
Lint Skipped - Unit
Unit Tests Skipped
Comment Actions
Thanks for looking at completing this. Indeed that's needed. Improvements still required on grammar and on how generic those advises are.
| HACKING | ||
|---|---|---|
| 66 | First install the dependencies | |
| 67–79 | Too distro specific, could that be done in a more generic manner? Beside on Arch you cover cucumber but not on Mint that looks suspicious. | |
| 82–85 | I'd expect the mkdir and cd, etc. Really the commands to get the thing built from the source directory. | |
| 91 | "zanshin", lower case here. | |
| 93 | "tests" (missing plural). | |
| 94 | Unit Tests | |
| 96 | Note it runs the acceptance tests too. | |
| 97 | Acceptance Tests | |
| 98–99 | running ctest from $BUILDDIR/tests/features would be a better advice | |
Comment Actions
Correction to the first patch on HACKING D4225
I clicked on update patch.
PS : If I did it wrong please tell me :-)
Comment Actions
Now we're talking! I can properly review now.
Almost there, still a few adjustments needed IMO.
| HACKING | ||
|---|---|---|
| 10–11 | I wouldn't separate in two lists like that, since it's build instruction you need to install all the necessary to build and run anyway. Besides I think you got some of it wrong between depends and makedepends. So, simplify an make a single dependency list here. | |
| 25 | "tests" (plural missing) | |
| 32 | "zanshin" with a lower case Z here too. | |