Ran Ziv created ARIA-382:
----------------------------
Summary: README missing items
Key: ARIA-382
URL: https://issues.apache.org/jira/browse/ARIA-382
Project: AriaTosca
Issue Type: Task
Reporter: Ran Ziv
Priority: Minor
A bunch of items that should be added to the README:
* The current "getting started" example is only relevant to Linux (and macOS?)
- This should be noted, so Windows users don't try to run it.
* Add a link to API docs
* Add a link to an official Apache mirror for source code download; Also add a
short explanation on how to test signatures, or at least link
[here|https://www.apache.org/info/verification.html]
* Add instructions on how to run RAT checks
* Clarify installation instructions where it comes to installing via PyPI vs
via Source - This seemed to have already confused some people
* Consider adding a section explaining about how to use Cloudify plugins,
linking to the Cloudify's plugin adapter
* Note that the {{requirements.txt}} file is not used by {{pip}} by default
during installation (from source or from sdist), and therefore, during
installation, various (yet constrained) versions of dependencies may be
installed - and not necessarily the ones that were tested prior to release.
Users may install using requirements.txt explicitly, and be guaranteed the
exact versions for dependencies that were tested prior to release.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
