Project

General

Profile

Actions

Bug #5924

closed

ncf-builder Readme does not allows one to start using it

Added by François ARMAND almost 10 years ago. Updated over 2 years ago.

Status:
Rejected
Priority:
1 (highest)
Category:
Web - Technique editor
Target version:
Severity:
UX impact:
User visibility:
Effort required:
Priority:
0
Name check:
Fix check:
Regression:

Description

The Readme of ncf-builder has only one line shortly describing the app and what techno it uses.

What we want to also know is:

- in first, the list of prerequisite to be able to use it and a the list of command / config action to get a runnable instance
- main config option that the user should know so that she get a sense of what is configurable, + description about where the things are to learn more config possibilities
- the high level architecture, so that one is able to understand what is not working when it's not working
- link and info: demo, project site, source, etc

Actions

Also available in: Atom PDF