From 2739e197f8a4225b5ac20da1301aa45756fb4e94 Mon Sep 17 00:00:00 2001 From: Andre Maia Chagas Date: Sat, 16 Nov 2019 05:15:14 +0000 Subject: [PATCH 1/2] Add files via upload I'm part of an initiative to make hardware easy to discover. Named [Open Know How](https://openknowhow.org/) we've come up with a system where a simple file with metadata about a certain project would live in the project documentation page. From there we are working to create a web-crawler that is going to find these files and index them (the ultimate goal would be to have something like a "hardware" tab on google search (as other search engines). I took the liberty of creating one of these files for your project, with the bare minimum for it to be indexed in the future! I hope you don't mind! (it is just this .yml file that should live in the root of the repository) You can find more technical information about Open Know How [here](https://app.standardsrepo.com/MakerNetAlliance/OpenKnowHow/wiki) --- okh-lightm.yml | 170 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 okh-lightm.yml diff --git a/okh-lightm.yml b/okh-lightm.yml new file mode 100644 index 0000000..1c2e6ef --- /dev/null +++ b/okh-lightm.yml @@ -0,0 +1,170 @@ +# Open know-how manifest +# according to The Open Know-How Manifest Specification Version 1.0 +# for more info, see http://openknowhow.org/ + +# The content of this manifest file is licensed under a Creative Commons Attribution 4.0 International License. +# Licenses for modification and distribution of the hardware, documentation, source-code, etc are stated separately. + +# Remove any fields that are not used. Comments (beginning with '#') may also be removed. + +# Manifest metadata + +date-created: 2019-11-16 # YYYY-MM-DD + +#date-updated: [value] # YYYY-MM-DD + +manifest-author: + name: Andre Maia Chagas # required | text + affiliation: University of Sussex # text + email: a.maia-chagas@sussex.ac.uk # email address + +manifest-language: EN-UK + +#documentation-language: [language-code]-[region] + +#manifest-is-translation: +# title: [value] # text | Title of the original +# manifest: [value] # URL - Absolute path | OKH manifest location +# web: [value] # URL - Absolute path | web presence location +# lang: [language]-[region] # language of original + +#documentation-is-translation: +# title: [value] # text | Title of the original +# manifest: [value] # URL - Absolute path | OKH manifest location +# web: [value] # URL - Absolute path | web presence location +# lang: [language]-[region] # language of original + +# Properties + +title: LightM # required | text | A title to identify the thing + +description: | # required | paragraph + Here we work on the development of software tools and a low-cost open hardware setup to study how bacteria move. + +#intended-use: | # recommended | Paragraph +# [value] + +keywords: # At least one keyword is recommended | text array + - Microbiology + + +project-link: https://github.com/vektorious/lightM # At least project-link or documentation-home is required, otherwise recommended | absolute path URL + +#health-safety-notice: | # paragraph +# [value] + +#contact: +# name: [value] # text +# affiliation: [value] # text +# email: [value] # email address +# social: +# - platform: [value] # text +# user-handle: [value] # text + +contributors: # recommended + - name: Alexander Kutschera # text +# affiliation: [value] # text + email: alexander.kutschera@gmail.com # email address + +#image: [value] # recommended | absolute or relative path + +#version: [value] # text + +#development-stage: [value] # text + +#made: [true/false] # boolean - true or false + +#made-independently: [true/false] # boolean - true or false + +#standards-used: +# - standard-title: [value] # Required where used | Title of the standard used in developing the design or documentation +# publisher: [value] # Publisher of the standard +# reference: [value] # Reference indentifier of the standard (e.g. ISO 9001) +# certification: # If certification has been granted confirming compliance with the standard +# - certifier: [value] # Individual or organisation granting the certification. Use "Self" for self-certification +# date-awarded: [value] # Date certification was granted +# link: [value] # Link to evidence of certification (e.g. certificate). Use an an absolute path to an external resource or an absolute or relative path to evidence within the documentation. + +#derivative-of: +# title: [value] # text | Title of the original +# manifest: [value] # URL - Absolute path | OKH manifest location +# web: [value] # URL - Absolute path | web presence location + +#variant-of: +# title: [value] # text | Title of the original +# manifest: [value] # URL - Absolute path | OKH manifest location +# web: [value] # URL - Absolute path | web presence location + +#sub: +# title: [sub 1] # text | Title of the original +# manifest: [value] # URL - Absolute path | OKH manifest location +# web: [value] # URL - Absolute path | web presence location + +# License + +license: # At least one license is required | The format should be an SPDX identifier. See https://spdx.org/licenses/hardware: [value] # recommended | The license under which the hardware is released + #hardware: [value] # recommended | The license under which the documentation is released + documentation: MIT # recommended | The license under which the documentation is released + #software: [value] # recommended where software is used | The license under which the software is released + +#licensor: +# name: [value] # text +# affiliation: [value] # text +# email: [value] # email address + +# Documentation + +documentation-home: https://github.com/vektorious/lightM # At least one of the project-link or documentation-home fields is required | absolute path + +#archive-download: [value] # Absolute or relative path + +#design-files: # recommended +# - path: [value] # Absolute or relative path +# title: [value] # text + +#schematics: # recommended where applicable +# - path: [value] # Absolute or relative path +# title: [value] # text + +#bom: [value] # recommended | absolute or relative path | Direct the maker to the Bill of Materials + +#tool-list: [value] # recommended | absolute or relative path | Direct the maker to a list of tools required to make the thing + +#making-instructions: # recommended +# - path: [value] # Absolute or relative path +# title: [value] # text + +#manufacturing-files: # recommended where applicable +# - path: [value] # Absolute or relative path +# title: [value] # text + +#risk-assessment: # recommended +# - path: [value] # Absolute or relative path +# title: [value] # text + +#tool-settings: # recommended where applicable +# - path: [value] # Absolute or relative path +# title: [value] # text + +#quality-instructions: +# - path: [value] # Absolute or relative path +# title: [value] # text + +#operating-instructions: # recommended +# - path: [value] # Absolute or relative path +# title: [value] # text + +#maintenance-instructions: [value] # recommended +# - path: [value] # Absolute or relative path +# title: [value] # text + +#disposal-instructions: [value] # recommended +# - path: [value] # Absolute or relative path +# title: [value] # text + +#software: # recommended where applicable | Source code or executable software that the thing uses +# - path: [value] # Absolute or relative path +# title: [value] # text + +# User defined Fields +# Include any custom / extended fields here From 03f3bb2cc2710a935340298780db3644b40f54ea Mon Sep 17 00:00:00 2001 From: Andre Maia Chagas Date: Thu, 27 Feb 2020 15:24:33 +0000 Subject: [PATCH 2/2] add link to image... ... so it is rendered on https://okh.now.sh/ --- okh-lightm.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/okh-lightm.yml b/okh-lightm.yml index 1c2e6ef..1c45f0c 100644 --- a/okh-lightm.yml +++ b/okh-lightm.yml @@ -66,7 +66,7 @@ contributors: # recommended # affiliation: [value] # text email: alexander.kutschera@gmail.com # email address -#image: [value] # recommended | absolute or relative path +image: https://raw.githubusercontent.com/vektorious/lightm/master/img/lightM_logo_v1.png # recommended | absolute or relative path #version: [value] # text