Skip to content

Top-level general repository with documentation, licensing and information about this GitHub collection

Notifications You must be signed in to change notification settings

IEEE-Humanitarian/general

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

# ===========================================================================
# Copyright (C) 2016 IEEE SIGHT/HIC-Ottawa
# (https://github.com/IEEE-Humanitarian/general)
#
# The general folder has files related to IEEE's Humanitarian Open Source
# technology repository, including licenses to use under IEEE's
# Open Source Humanitarian Engineering Licensing Protocol (OS-HELP).
#
# The contents of this file are subject to the terms of the Creative
# Commons BY-SA License, v. 4.0. If a copy of the CC BY-SA
# was not distributed with this folder contents, you can obtain one
# at (http://creativecommons.org/licenses/by-sa/4.0/)
# ---------------------------------------------------------------------------
#  $Author: alfredoh1234$
# ===========================================================================
Projects in the IEEE Humanitarian open source repository have been peer-reviewed 
and published in proceedings, journal or academic publication.
Pre-publications work can be hosted during peer-review/certification phase. 

Repository directory structure:  
a) All projects in this repository follow the directory structure shown below.
b) Each directory shall have a text file describing its contents, named "<dir-name>_README.txt"
c) Each "<dir-name>_README.txt" file shall have a duplicate named "README" (for GitHub)
d) Directory structure represents activity area(s) for work/structure and may include:

[design]      only contains folders and design_README.txt/README
-> [bin]      executables, toolchain/CAD and scripts (PERL, Python, shell, etc)
-> [doc]      specifications, requirements, references
-> [1_model]  for example, octave files
-> [2_mech]   for example, FreeCAD, 3D printer (stl) files
-> [3_elechw] for example, Qucs files
-> [4_pcb]    for exmaple, KiCAD files
-> [5_sw-app] application running on project. For exampel, C/C++, Java files
-> [sys-int]  system bring-up, integration, verification 
-> [misc]     miscelaneous

[project] project files, budget, risk & issue record...
-> [legal] patent references, certifications, standards
-> [peer-review] peer-reviewed publication of project, release/hand-over OM&A documention

# ===========================================================================
# Change History
# ---------------------------------------------------------------------------
#  $Revision: 0.2 $
#  $Date: 28-February-2016$
#  $Log: minor changes, typos$
#
#  $Revision: 0.1 $
#  $Date: 11-February-2016$
#  $Log: Initial commit$
# ===========================================================================

About

Top-level general repository with documentation, licensing and information about this GitHub collection

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published