search

reTHINK-project / core-framework

The main goal of WP3 is to provide the reTHINK core framework comprised by the runtime environment where Hyperties are executed and the messaging nodes used to support messages exchange between Hyperties.
Apache License 2.0
1 stars 0 forks source link

Readme Documentation structure #163

Closed pchainho closed 8 years ago

pchainho commented 8 years ago

Currently, the different documentation available in the Readme file of each dev repository is not following similar structures. Taking into account that this will be the starting point for external users and developers, we should be careful on this structure and try to have a common basis to facilitate its understanding by users browsing through the different repos. The following structure is proposed:

Name of the component (Header 2)

Overview (Header 3)

Short introduction about provided features and its functional location in terms of reTHINK Arch having as reference the Getting Started doc

User View (Header 3)

The different steps to be performed in order to setup the user environment and how to use the component. For Msg Nodes it would be installation, configuration and operations guidelines. For libs to be imported by other components (eg service framework and runtime) it would be the different steps on how to import and invoke main APIs. Details should be provided elsewhere eg service framework should have links to Hyperty development tutorial.

Developer View (Header 3)

The different steps to be performed in order to setup the development environment and how to extend or change the source code. Details should be provided elsewhere including details about internal arch, packages structure and APIs.

antonroman commented 8 years ago

@pchainho can we add headers of lower levels below Headers 3? Thanks!

pchainho commented 8 years ago

sure