Poor Documentation for building #107

New issue

Open

opened 2021-01-31 04:40:16 +00:00 by joybuke · 0 comments

joybuke commented

2021-01-31 04:40:16 +00:00

The manual build section lists "necessary patches" without listing what patches they are and mentions applying the patches without giving anything more than an unhelpful command as an example. The second issue is worse as it doesn't tell how to apply the patches, what to apply them to, or any detail that could allow either of those to be inferred. This means that, unless you have adequate experience with the patch command, you will not be able to build.

The fix to this would simply be adding more detail to the manual build and cleaning up the default config file to be more generic and easy to change.

As it stands, the documentation for a manual build is confusing and needs more detail. The example ctcconfig is not adaptable for most people for ease of use; ctcconfig does not have sane defaults in its example file. The manual build section lists "necessary patches" without listing what patches they are and mentions applying the patches without giving anything more than an unhelpful command as an example. The second issue is worse as it doesn't tell how to apply the patches, what to apply them to, or any detail that could allow either of those to be inferred. This means that, unless you have adequate experience with the patch command, you will not be able to build. The fix to this would simply be adding more detail to the manual build and cleaning up the default config file to be more generic and easy to change.

👍 1

This repo is archived. You cannot comment on issues.