On 25/03/2017 20:22, Michael D. L. wrote:


On 03/25/2017 10:58 AM, Pierre Labastie wrote:
Hi,
I'd like to know what the followers of this list think about jhalfs documentation, and what would be their advises for improving it. Personally, I have not much idea of how documentation should be done, and apart from text improvement (there is room for that), I am happy with the "README" format (supplemented by help in menus). But some of you may have more clever ideas. So please speak up.

Regards
Pierre
Hi Pierre,

When I started (or tried starting) using jhalfs, I didn't find the current Documentation helpful in any way.

Lot's of technical description of HOW it worked, but not how to USE it.

Only because I like to try/test/experiment I managed to make jhalfs automate my LFS build.

A "How to use" section, with simple examples, and various build-version/types/variation would be very useful.

Make it easy to start using so you don't have to guess about what to enter.

Hi Michael,

Thanks for the answer. I understand it is hard for newcomers to use the tool by looking at the documentation only. It seems the main problem is that it is hardly (or nowhere) said what should be done _before_ running "make". I'll try to add a few sentences to the README file (there does not need to be many, I think).

But do you see other areas where some help is needed? Maybe a "tutorial" about which options to select for a first build?

Or just have the default options "work" provided the right directory has been created with the right mode and owner...

Regards
Pierre
--
http://lists.linuxfromscratch.org/listinfo/alfs-discuss
FAQ: http://www.linuxfromscratch.org/faq/
Unsubscribe: See the above information page

Reply via email to