+ + http://developer.github.com https://help.github.com/articles/creating-an-access-token-for-command-line-use -
http://developer.github.com https://help.github.com/articles/creating-an-access-token-for-command-line-use -
+ + + but it does not. Rather it simply reads in a zip file of the repo and unzips + it from RAM as needed. Therefore the PLUGIN is read only for accessing + remote pretty libraries at https://github.com. The "Library Path" in the + fp-lib-table row for a Github library should be set to the full https:// URL. + For example: + + https://github.com/liftoff-sr/pretty_footprints -
https://github.com/liftoff-sr/pretty_footprints -
+ https://github.com/user_name/repo_name +
+ + This PLUGIN also supports "Copy On Write", a.k.a. "COW". Thus a Github + library defined in either the fp-lib-table (project or global) will take an + optional option called allow_pretty_writing_to_this_dir. This option + is essentially the "Library Path" for a local Kicad (pretty) library which is + combined to make up the Github library found in the same fp-lib-table row. If + the option is missing, then the Github library is read only as always. If the + option is present for a Github library, then any writes to this library will + go to the local *.pretty directory. Note that the github.com resident portion + of this hybrid COW library is always read only, meaning you cannot delete + anything or modify any footprint at github directly.
- This PLUGIN also supports "Copy On Write", a.k.a "COW". So a library defined - in the fp-lib-table will take an optional option called - allow_pretty_writing_to_this_dir which is essentially the lib_path for - a local Kicad (pretty) library which is combined to make up the Github library. - If the option is missing, then the Github library is read only. If it is present, - then any writes will go to the local *.pretty directory. Any reads will always - give precedence to the local footprints. So once you have written to the local - directory, no github updates will travel down on any footprints for which you've - written locally. Always keep a separate local *.pretty directory for each Github - library, never combine them you will likely create a mess. You must manually - create the local directory in advance, and the directory name must end with ".pretty". - The option allow_pretty_writing_to_this_dir will be path substituted with - any environment variable strings embedded in the option's value, just like the + + Any footprint loads will always give precedence to the local footprints found + in the pretty dir given by option allow_pretty_writing_to_this_dir. So + once you have written to the COW library's local directory by doing a + footprint save, no github updates will be seen when loading a footprint by + the same name as one for which you've written locally. + +
+ + Always keep a separate local *.pretty directory for each Github library, + never combine them by referring to the same directory more than once. Also, + do not also use the same COW (*.pretty) directory in a "Kicad" fp-lib-table + entry. This would likely create a mess. The COW directory should be manually + created in advance, and the directory name must end with ".pretty". The value + of the option allow_pretty_writing_to_this_dir will be path + substituted with any environment variable strings embedded, just like the "Library Path" is. -
- What's the point of COW? It is to turbo charge the sharing of footprints. If you - periodically email your COW pretty footprints to the Github repo maintainer, - you can help update the Github copy. The idea should be to keep the COW file - set as small as possible. After you've received confirmation that your changes - have been committed up at github.com, you can safely delete your COW file(s) - and those from github.com will flow down. -
- Note that if you use the module editor to delete a footprint and it is present - in the COW local dir, it will get deleted from there. However, it may not - be deleted from the library as a whole if the footprint of the same name also - existed in the github repo. In this case deleting the local copy will simply - unmask the one at the github repo. Remember, it is masked out if there is - a local COW copy, since the local copy always takes precedence. - * - * @author Dick Hollenbeck - * @date Original date: 10-Sep-2013 +
+ + What's the point of COW? It is to turbo-charge the sharing of footprints. If + you periodically email your COW pretty footprint modifications to the Github + repo maintainer, you can help update the Github copy. Simply email the + individual *.kicad_mod file you find in your COW directories. After you've + received confirmation that your changes have been committed up at github.com, + you can safely delete your COW file(s) and those from github.com will flow + down. Your goal should be to keep the COW file set as small as possible by + contributing frequently to the shared master copies at https://github.com. + +
+ + Note that if you use the module editor to delete a footprint and it is + present in the COW local dir, it will get deleted from there. However, it may + not be deleted from the library as a whole if the footprint of the same name + also exists in the github repo. In this case deleting the local copy will + simply unmask the one at the github repo. Remember, it is masked out if there + is a local COW copy, since the local copy always takes precedence. And + remember you cannot modify the github copy except by emailing a COW + modification to the repo maintainer. + + @author Dick Hollenbeck + @date Original date: 10-Sep-2013 + */ class GITHUB_PLUGIN : public PCB_IO {