Skip to content
/ skeleton Public template

Skeleton repository as guideline for newer repositories.

Notifications You must be signed in to change notification settings

akornsys-rdi/skeleton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Skeleton

Akornsys RDI OSHW SPFMDBC

     ___ _       _     _            
    / __| |_____| |___| |_ ___ _ _  
    \__ \ / / -_) / -_)  _/ _ \ ' \ 
    |___/_\_\___|_\___|\__\___/_||_|

A repository template

Long description goes here.

📂 Repository content

Skeleton can be obtained on GitHub: Skeleton.

This project may contain some of the following sections:

Hardware

  • /3d/ 3D modeling, source and rendering designs.
  • /brd/ EDA designs, schematics, PCBs, libraries, datasheets and manufacturing files such as gerber, BoM and PDF.
  • /hdl/ Hardware description files, such as VHDL.

Software

  • /src/ Firmware or software files, source and compiled.

Documentation

  • /doc/ Written or graphic documentation.
  • Any file containing project information at the root of the project, including the README.
  • Wiki or gh-pages if available.

🚀 Getting started

Main section. write here all the necessary content for the correct manufacture and assembly. Include all necessary subsections.

Visit the official documentation to find out a detailed guide.

3D Printing

Here can be an optional section of the 3D printing.

Electronic designs

Here can be an optional section of the electronic design.

Firmware

Here can be an optional section of the firmware.

Assembly

Here can be an optional section of the assembly.

📖 Version history

Skeleton uses Semantic Versioning. For the versions available, see the tags on this repository.

Skeleton version 1.0-rc1 is the latest stable version.

Roadmap

Here can be an optional section of the roadmap or ToDo.

❤️ Community and contributions

Donate using Liberapay Support me on Ko-Fi Tindie Shop

Contributions are always welcome!

This is a community-driven open source project. Any contribution is highly appreciated, whether you are helping fixing bugs or proposing new features, pulling requests, improving the documentation or spreading the word.

Please ⭐ or watch this repository if this project helped you! You can also support this project on Liberapay, Ko-Fi or buy it in Tindie.

⚠️ NOTE: If you are going to make your own copy (clone) or fork, please remove the brand name and logo from your design, as well the S/N. The license and copyright notice must be retained.

📜 Copyright & License

Copyright © 2020 RileyStarlight

Hardware

Cern OHL-S 2

The hardware of this project is licensed under CERN-OHL-S 2, see the LICENSE.OHLS2.txt file for details.

Software

GNU/GPL 3

The software of this project is licensed under GNU/GPL 3, see the LICENSE.GPL3.txt file for details.

Documentation

CC BY SA 4.0

The documentation of this project is licensed under CC BY SA 4, see the LICENSE.BYSA4.txt file for details.

About

Skeleton repository as guideline for newer repositories.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published