You've already forked pidcodes.github.com
mirror of
https://github.com/solokeys/pidcodes.github.com.git
synced 2026-03-11 17:14:52 -07:00
e520c07938
* Remove errant .DS_Store file * Ignore .DS_Store * Create a list of organisations * Add an org list * Show number of PIDs per org * Fix HTML issue, sort orgs by title * Try and fix the PID count * Try and fix issues * Try again to fix issues * Try yet again to fix issues * Correct the urlpart * Change to sort_natural, minor code tidy * Try and fix the sorting * Try again to fix the sorting * Remove debugging * Add a link to orgs page * Turn on the remaining redcarpet extensions so we match GitHub From https://george-hawkins.github.io/basic-gfm-jekyll/redcarpet-extensions.html * Switch to kramdown * Turn on some other options * Add a site field to orgs * Add more org websites * Add the site field to the how to
60 lines
3.6 KiB
Markdown
60 lines
3.6 KiB
Markdown
---
|
|
layout: page
|
|
title: How to get a PID code
|
|
permalink: /howto/
|
|
---
|
|
## 0. Prerequisites
|
|
If your project does not meet the following criteria, your pull request **will** be rejected:
|
|
|
|
- Publicly available source code repository...
|
|
- Containing schematics or source code for a device with a USB interface...
|
|
- Licensed under a recognized open source or open source hardware license. Your source code repository must contain a LICENSE file attesting to this fact.
|
|
|
|
If your project involves both hardware and software, both need to be licensed under recognised OSS and OSHW licenses. If your project involves only one or the other, we may ask for further justification as to why you need a PID associated with your software project / development board instead of allowing end-users to request their own.
|
|
|
|
If your project doesn't yet meet these requirements, please hold off requesting a PID until it does. Don't worry, we're not likely to run out of PIDs soon.
|
|
|
|
## 1. Fork us
|
|
Create a fork of [our repository](https://github.com/pidcodes/pidcodes.github.com) on GitHub.
|
|
|
|
## 2. Set up your organisation page
|
|
Create a directory named after your organisation in the `org` directory. Create a file inside it called `index.md` and add the following content:
|
|
|
|
```
|
|
---
|
|
layout: org
|
|
title: My organisation
|
|
site: http://www.myorg.org/
|
|
---
|
|
A short description of my organisation and what it does.
|
|
```
|
|
|
|
If it's just you, that's fine too - put your own name and a short blurb about you and what you do. The site is an optional website for your organisation.
|
|
|
|
## 3. Find a VID and PID
|
|
Browse the [list of PIDs](/1209/) for an unused PID number. You may request any number that is not in use, except those reserved as described on the VID page. Note that PIDs on our existing VID, 0x1209, may not start with 0x1xxx - this range is reserved by the original owners of the VID.
|
|
|
|
When you've found a PID, create a directory named after it in the VID directory. So, if you picked PID `2345` on VID `1209`, create a directory with the path `/1209/2345/`. Inside it, create a file called `index.md` and add the following content:
|
|
|
|
```
|
|
---
|
|
layout: pid
|
|
title: My device name
|
|
owner: myorg
|
|
license: MIT
|
|
site: http://www.mysite.com/
|
|
source: http://github.com/myorg/mydevice/
|
|
---
|
|
```
|
|
|
|
The `title` field is what will appear on the pid.codes directory. Titles will be prefixed with the name of your organisation, so don't include that in the title. Try and pick a name you'd want to see in Device Manager or dmesg.
|
|
|
|
For the `owner` field, specify the name of the directory you created for your organisation in step 2. For license, you must name a valid open-source license; pull requests that do not have this field filled out correctly will be rejected.
|
|
|
|
The `site` field should point to the most relevant URL about your project. The `source` field must point to a URL at which users can find the source code for your device; this includes both PCB designs and firmware. This does not have to be on GitHub. The two URLs can be the same.
|
|
|
|
Under the second triple-dashed line, you may write a short description of your project, if you wish; this is not mandatory.
|
|
|
|
## 4. Send us a pull request
|
|
Commit your changes to your fork of the repository with a descriptive commit message, and [send us a pull request](https://help.github.com/articles/using-pull-requests/). Pull requests will only be accepted if they follow the rules laid out for the VID you are requesting a PID under. If this is not your first PID, or you're requesting multiple PIDs, we may ask for more details and justification. Once we accept your pull request, your registration will go live and appear on pid.codes.
|