Documentation organization: Difference between revisions
No edit summary |
|||
| Line 2: | Line 2: | ||
Even after two versions of the Midas documentation, it is still a real challenge to describe the Midas package in a clear, concise and useful way. On this third attempt, we reworked the layout and placed everything on Wiki, hoping that collaborators will be keen to correct, add and improve its content. Feel free to do so by contacting us in case of unclear or incomplete information. | Even after two versions of the Midas documentation, it is still a real challenge to describe the Midas package in a clear, concise and useful way. On this third attempt, we reworked the layout and placed everything on Wiki, hoping that collaborators will be keen to correct, add and improve its content. Feel free to do so by contacting us in case of unclear or incomplete information. | ||
We split the documentation in 4 main sections: 'Installation', 'Feature listing', 'Application listing', 'Online Database' | |||
While the first one provide you a mean to get Midas up and running, the 'Feature listing' should provide a sense of what Midas can do. The 'Application listing' | |||
refers to '''system- & user- build''' applications that maybe needed during the acquisition. The 'Online Database' section describe in details | |||
* Installation section | * Installation section | ||
While originally Midas was available for all sorts of OS, now-a-days, we tend to reduce its support to Linux based, | While originally Midas was available for all sorts of OS, now-a-days, we tend to reduce its support to Linux based, MacOS, and windows. | ||
While 'Midas package retrieval' and 'quick start' sections are OS independent, specific procedure on OS based is given for compilation/build/dependencies. | |||
* Feature listing | |||
Feature listing refers to the particular of the Midas | |||
Revision as of 12:53, 30 October 2013
How this documentation is organized
Even after two versions of the Midas documentation, it is still a real challenge to describe the Midas package in a clear, concise and useful way. On this third attempt, we reworked the layout and placed everything on Wiki, hoping that collaborators will be keen to correct, add and improve its content. Feel free to do so by contacting us in case of unclear or incomplete information. We split the documentation in 4 main sections: 'Installation', 'Feature listing', 'Application listing', 'Online Database' While the first one provide you a mean to get Midas up and running, the 'Feature listing' should provide a sense of what Midas can do. The 'Application listing' refers to system- & user- build applications that maybe needed during the acquisition. The 'Online Database' section describe in details
- Installation section
While originally Midas was available for all sorts of OS, now-a-days, we tend to reduce its support to Linux based, MacOS, and windows. While 'Midas package retrieval' and 'quick start' sections are OS independent, specific procedure on OS based is given for compilation/build/dependencies.
- Feature listing
Feature listing refers to the particular of the Midas