Open k-dovgan opened 5 years ago
A tutorial:
Analogy: teaching a small child how to cook
A how-to guide:
Analogy: a recipe in a cookery book
An explanation:
Analogy: an article on culinary social history
A reference guide:
Analogy: a reference encyclopaedia article
Preliminary plan for tutorial or set of tutorials
2\. Universum installation
This has to be supported by a smoke test after the installation. For the purposes of tutorial it makes sense to allow super-quick creation of test project. Right now, there are bash scripts and configs in the repo that can serve this purpose, but they are not installed as a part of universum installation. Some options:
@k-dovgan, thoughts?
I'm not sure about templates, especially templates of example source code, but adding interactive universum create-config
sounds not that bad. So maybe we can add some simple 'project' (like, one script, maybe?) to the guide and to the 'examples' directory, and suggest user to use this universum create-config
on it? And then cite the created config in guide for user to check?
So maybe we can add some simple 'project' (like, one script, maybe?) to the guide and to the 'examples' directory, and suggest user to use this
universum create-config
on it? And then cite the created config in guide for user to check?
No, this would require user to work with repository. universum create-config
should be able to work right after installation and create viable project without any additional sources.
Illia asked to add separate paragraph about updating Universum to newer version for those unfamiliar with Pip
create-config
now has it's own issue: #517
Originally created on Wed, 26 Dec 2018 13:58:39 +0200
Add simple step-by-step guide as an example of usage to documentation.