element14 Community
element14 Community
    Register Log In
  • Site
  • Search
  • Log In Register
  • Community Hub
    Community Hub
    • What's New on element14
    • Feedback and Support
    • Benefits of Membership
    • Personal Blogs
    • Members Area
    • Achievement Levels
  • Learn
    Learn
    • Ask an Expert
    • eBooks
    • element14 presents
    • Learning Center
    • Tech Spotlight
    • STEM Academy
    • Webinars, Training and Events
    • Learning Groups
  • Technologies
    Technologies
    • 3D Printing
    • FPGA
    • Industrial Automation
    • Internet of Things
    • Power & Energy
    • Sensors
    • Technology Groups
  • Challenges & Projects
    Challenges & Projects
    • Design Challenges
    • element14 presents Projects
    • Project14
    • Arduino Projects
    • Raspberry Pi Projects
    • Project Groups
  • Products
    Products
    • Arduino
    • Avnet & Tria Boards Community
    • Dev Tools
    • Manufacturers
    • Multicomp Pro
    • Product Groups
    • Raspberry Pi
    • RoadTests & Reviews
  • About Us
  • Store
    Store
    • Visit Your Store
    • Choose another store...
      • Europe
      •  Austria (German)
      •  Belgium (Dutch, French)
      •  Bulgaria (Bulgarian)
      •  Czech Republic (Czech)
      •  Denmark (Danish)
      •  Estonia (Estonian)
      •  Finland (Finnish)
      •  France (French)
      •  Germany (German)
      •  Hungary (Hungarian)
      •  Ireland
      •  Israel
      •  Italy (Italian)
      •  Latvia (Latvian)
      •  
      •  Lithuania (Lithuanian)
      •  Netherlands (Dutch)
      •  Norway (Norwegian)
      •  Poland (Polish)
      •  Portugal (Portuguese)
      •  Romania (Romanian)
      •  Russia (Russian)
      •  Slovakia (Slovak)
      •  Slovenia (Slovenian)
      •  Spain (Spanish)
      •  Sweden (Swedish)
      •  Switzerland(German, French)
      •  Turkey (Turkish)
      •  United Kingdom
      • Asia Pacific
      •  Australia
      •  China
      •  Hong Kong
      •  India
      • Japan
      •  Korea (Korean)
      •  Malaysia
      •  New Zealand
      •  Philippines
      •  Singapore
      •  Taiwan
      •  Thailand (Thai)
      • Vietnam
      • Americas
      •  Brazil (Portuguese)
      •  Canada
      •  Mexico (Spanish)
      •  United States
      Can't find the country/region you're looking for? Visit our export site or find a local distributor.
  • Translate
  • Profile
  • Settings
Sci Fi Your Pi
  • Challenges & Projects
  • Design Challenges
  • Sci Fi Your Pi
  • More
  • Cancel
Sci Fi Your Pi
Blog Meditech: Open source software repository and documentation
  • Blog
  • Forum
  • Documents
  • Files
  • Mentions
  • Sub-Groups
  • Tags
  • More
  • Cancel
  • New
  • Share
  • More
  • Cancel
Group Actions
  • Group RSS
  • More
  • Cancel
Engagement
  • Author Author: balearicdynamics
  • Date Created: 3 Jul 2015 4:55 PM Date Created
  • Views 1272 views
  • Likes 1 like
  • Comments 2 comments
  • doxygen
  • meditech_project
  • open_source
  • github
  • raspberry-pi
  • software_sources
  • apache_license
  • sci_fi_your_pi
  • software_documentation
Related
Recommended

Meditech: Open source software repository and documentation

balearicdynamics
balearicdynamics
3 Jul 2015

Software sources

The Meditech software has been divided into packages everyone related to a specific context. Every package will be included in a separate repository folder following its own lifetime and in the meantime it is accessible from a unique Git entry point on GitHub. that is the user alicemirror.

 

The first setup repository, also used here as example is the chipkit_serial_pi To access the software sources you can download the repo from GitHub at the following address: https://github.com/alicemirror/chipkit_serial_pi or, alternatively, cloning the repository with the command

 

git clone https://github.com/alicemirror/chipkit_serial_pi.git

 

At the actual date third party software used in the sources are open source with the license explicitly declared in the sources. The Meditech sources are distributed with the Apache license but this choice maybe subject to changes in the future as a definitive licensing system has not yet been adopted.

 

Software documentation

To keep the sources documentation always updated with the sources every package has its own documentation automatically created with Doxygen in two formats: html and pdf. And example of the pdf documentation can be downloaded at the bottom.

 

The advantage using Doxygen to generate in-line documentation is to have an always updated program and documentation with a minimum effort. In addition to the usual software documentation (doxygen-encoded) some sources also includes in the header comment documentation pages referred to some special feature or behaviour of the program.

 

The html documentation is updated every new version of the software and is published on the site http://meditech.balearicdynamics.com/doc one folder every repository. This results in a series of independently navigable static sites kept constantly updated, The root to access the Meditech software documentation packages is http://meditech.balearicdynamics.com/doc where every package can be accessed in a specific folder. To see an example check the last update of the ChipKit PI documentation package, as shown in the image below.

image

Attachments:
imagerefman.pdf
  • Sign in to reply
  • balearicdynamics
    balearicdynamics over 10 years ago in reply to DAB

    Thank you DAB. The limitation on this documentation way I see is a lack of a global view instead of a global documentation. But I don't see another way to keep the things organised, also because I should develop the parts following different approaches.

     

    Enrico

    • Cancel
    • Vote Up 0 Vote Down
    • Sign in to reply
    • More
    • Cancel
  • DAB
    DAB over 10 years ago

    Great start at a reference manual.

     

    Well done.

     

    DAB

    • Cancel
    • Vote Up 0 Vote Down
    • Sign in to reply
    • More
    • Cancel
element14 Community

element14 is the first online community specifically for engineers. Connect with your peers and get expert answers to your questions.

  • Members
  • Learn
  • Technologies
  • Challenges & Projects
  • Products
  • Store
  • About Us
  • Feedback & Support
  • FAQs
  • Terms of Use
  • Privacy Policy
  • Legal and Copyright Notices
  • Sitemap
  • Cookies

An Avnet Company © 2026 Premier Farnell Limited. All Rights Reserved.

Premier Farnell Ltd, registered in England and Wales (no 00876412), registered office: Farnell House, Forge Lane, Leeds LS12 2NE.

ICP 备案号 10220084.

Follow element14

  • X
  • Facebook
  • linkedin
  • YouTube