mirror of
https://github.com/ijprest/keyboard-layout-editor
synced 2024-11-13 07:10:41 +00:00
Cleaned up CONTRIB & README
This commit is contained in:
Ian Prest
parent
7724b33fc1
commit
13211e53c8
123
CONTRIB.md
123
CONTRIB.md
@ -2,10 +2,15 @@ Contributors
|
||||
------------
|
||||
Special thanks to the following contributors:
|
||||
* [gcolic](https://github.com/gcollic), for providing WASD color presets
|
||||
* [D1SC0tech](https://github.com/D1SC0tech), for initial DSA homing/deep-dish support
|
||||
* [jasonm23](https://github.com/jasonm23), for initial Custom Styles implementation
|
||||
* [D1SC0tech](https://github.com/D1SC0tech), for initial DSA homing/deep-dish
|
||||
support
|
||||
* [jasonm23](https://github.com/jasonm23), for initial Custom Styles
|
||||
implementation
|
||||
* [iandoug](http://iandoug.com/?p=64), for the case background textures &
|
||||
related options.
|
||||
|
||||
The following users have contributed some of the sample keyboard layouts & presets:
|
||||
The following users have contributed some of the sample keyboard layouts &
|
||||
presets:
|
||||
* [domgetter](https://github.com/domgetter)
|
||||
* [rswiernik](https://github.com/rswiernik)
|
||||
* [BlueNalgene](https://github.com/BlueNalgene)
|
||||
@ -15,7 +20,8 @@ The following users have contributed some of the sample keyboard layouts & prese
|
||||
|
||||
Third-Party Software
|
||||
--------------------
|
||||
The following third-party software packages were used in the creation of keyboard-layout-editor.com:
|
||||
The following third-party software packages were used in the creation of
|
||||
keyboard-layout-editor.com:
|
||||
* [AngularJS](https://angularjs.org/)
|
||||
* [AngularUI](https://angular-ui.github.io/)
|
||||
* [ng-file-upload](https://github.com/danialfarid/ng-file-upload)
|
||||
@ -32,75 +38,50 @@ The following third-party software packages were used in the creation of keyboar
|
||||
* [Hint.css](http://kushagragour.in/lab/hint/) (CSS-only tooltips)
|
||||
* [doT.js](http://olado.github.io/doT/) (fast micro-templating)
|
||||
* [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
|
||||
* [C64 TrueType Font](http://style64.org/c64-truetype) font (by [Style64.org](https://www.style64.org))
|
||||
* [C64 TrueType Font](http://style64.org/c64-truetype) font (by
|
||||
[Style64.org](https://www.style64.org))
|
||||
|
||||
Acknowledgements for Backgrounds
|
||||
--------------------------------
|
||||
There is an increasing trend towards using non-plastics to make custome keyboards.
|
||||
Backgrounds Textures
|
||||
--------------------
|
||||
There is an increasing trend towards using non-plastic materials to make
|
||||
custom keyboards. We provide selection of background textures to aid in
|
||||
designing & visualizing such keyboards.
|
||||
|
||||
For example, see
|
||||
* [Keyboard.io](http://shop.keyboard.io/)
|
||||
* [DataMancer Diviner](http://www.datamancer.com/cart/the-diviner-keyboard-p-204.html)
|
||||
* [Dave Smith carbon fibre project](http://linustechtips.com/main/topic/410454-a-keyboard-build-log-by-davsmith4/)
|
||||
* [The self-made marble keyboard](http://www.thiemo.net/misc/kezboard/)
|
||||
* [Carbon fibre keyboard](http://i.imgur.com/yPbsLjy.jpg)
|
||||
* [Carbon fibre mouse and keyboard](http://themodzoo.com/forum/index.php/topic/280-diy-mod-guide-di-noc-carbon-fiber-gaming-mouse/)
|
||||
The textures were sourced from various sites around the web and are believed
|
||||
to all be free to use. In some cases, the source images were scaled, rotated,
|
||||
or cropped. If you feel your copyright is being infringed, please advise and
|
||||
the offending material will be removed.
|
||||
|
||||
To this end, KLE provides a selection of backgrounds which may possibly be used to aid in designing such keyboards.
|
||||
|
||||
These backgrounds are all big enough for standard layouts ... just be sure to set the size of the background
|
||||
to prevent unwanted tiling. The standard ANSI 104 fits happily into a 1250 px background.
|
||||
|
||||
Materials currently in the lineup are:
|
||||
|
||||
* Carbon fibre
|
||||
* Leather
|
||||
* Marble
|
||||
* Metal
|
||||
* Plastic
|
||||
* Wood
|
||||
|
||||
The backgrounds were sourced from various sites around the web and are believed to all be
|
||||
free to use. If you feel your copyright is being infringed, please advise and the offending
|
||||
material will be removed.
|
||||
|
||||
The source materials were generally used as follows:
|
||||
* in some cases of close-up photos, reduced 50% x/y, and/or
|
||||
* rotated, and/or
|
||||
* cropped to around 2000x1000 px, and/or
|
||||
* used as-is.
|
||||
|
||||
|
||||
The plastic backgrounds were created by selecting a small, defect-free region of photographs of Signature Plastics colour
|
||||
samples, and making them into seamless tiles in Gimp.
|
||||
|
||||
While Signature Plastics does NOT make keyboard cases, the technique provides a useful selection of
|
||||
plastic colours used by others in making keyboard cases. It also opens up the possibility down the
|
||||
road of using the textures as backgrounds to the keys themselves.
|
||||
|
||||
|
||||
Most of the following materials are from bgfons.com:
|
||||
* [Aluminium](http://bgfons.com/img/materials/aluminum)
|
||||
* [Carbon fibres](http://bgfons.com/img/materials/carbon)
|
||||
* [Titanium](http://bgfons.com/img/materials/titanium)
|
||||
* [Iron/Steel](http://bgfons.com/img/materials/iron)
|
||||
* [Marble](http://bgfons.com/img/materials/marble)
|
||||
* [Leather](http://bgfons.com/img/materials/leather)
|
||||
|
||||
Two leather textures (black.jpg and brown.jpg) are from
|
||||
* [Free PSD file](http://freepsdfiles.net/backgrounds/4-free-leather-textures)
|
||||
|
||||
Some metal and most wood textures are from [CadNav](http://www.cadnav.com/), who have the following terms:
|
||||
|
||||
* INFO: Please read and comply with the terms and conditions, otherwise please don't use this model
|
||||
|
||||
1. We don't accept any claims regarding quality of 3D model or any standards conformity.
|
||||
2. We will not participate in any technology or copyright issues.
|
||||
3. This file (models or textures) may be used in any commercial way only as a part of artwork or project. Single reselling or redistribution of this model is prohibited.
|
||||
4. This file (models or textures) may be freely modificated or elaborated.
|
||||
5. If you use this file (models or textures) in your project or website, please indicate the source from cadnav.com
|
||||
|
||||
|
||||
The red mahogany is from [SweetSoulSister](http://sweetsoulsister.deviantart.com/art/Red-Mahogany-Wood-Texture-146083467)
|
||||
Sources:
|
||||
|
||||
* Many of the materials were sourced from [bgfons.com](http://bgfons.com):
|
||||
* [Aluminium](http://bgfons.com/img/materials/aluminum)
|
||||
* [Carbon fibres](http://bgfons.com/img/materials/carbon)
|
||||
* [Titanium](http://bgfons.com/img/materials/titanium)
|
||||
* [Iron/Steel](http://bgfons.com/img/materials/iron)
|
||||
* [Marble](http://bgfons.com/img/materials/marble)
|
||||
* [Leather](http://bgfons.com/img/materials/leather)
|
||||
* The 'Plastic' backgrounds were created by selecting a small, defect-free
|
||||
region of photographs of [Signature Plastics](http://www.keycapsdirect.com/)
|
||||
colour swatches and then making them into seamless tiles in Gimp.
|
||||
* Note that Signature Plastics does not manufacture actual keyboard cases.
|
||||
* Two of the 'Leather' textures ('Black' and 'Brown') are from
|
||||
[Free PSD Files](http://freepsdfiles.net/backgrounds/4-free-leather-textures).
|
||||
* 'Red Mahogany' is by DeviantArt user [SweetSoulSister](http://sweetsoulsister.deviantart.com/art/Red-Mahogany-Wood-Texture-146083467)
|
||||
* Most of the 'Wood' textures and some of the metallic textures are from
|
||||
[CadNav](http://www.cadnav.com/), who have the following license:
|
||||
|
||||
````
|
||||
INFO: Please read and comply with the terms and conditions, otherwise please
|
||||
don't use this model
|
||||
|
||||
1. We don't accept any claims regarding quality of 3D model or any standards
|
||||
conformity.
|
||||
2. We will not participate in any technology or copyright issues.
|
||||
3. This file (models or textures) may be used in any commercial way only as a
|
||||
part of artwork or project. Single reselling or redistribution of this model
|
||||
is prohibited.
|
||||
4. This file (models or textures) may be freely modificated or elaborated.
|
||||
5. If you use this file (models or textures) in your project or website,
|
||||
please indicate the source from cadnav.com.
|
||||
````
|
||||
|
||||
@ -30,6 +30,7 @@ Required Tools:
|
||||
|
||||
* NodeJS/NPM: https://nodejs.org/
|
||||
* GNU Make: http://www.gnu.org/software/make/
|
||||
* FontForge: http://fontforge.github.io/en-US/
|
||||
* Bower: ```npm install -g bower```
|
||||
* Grunt: ```npm install -g grunt-cli```
|
||||
* Protractor: ```npm install -g protractor```
|
||||
@ -38,7 +39,6 @@ Required Tools:
|
||||
* Stylus: ```npm install -g stylus```
|
||||
* Jison: ```npm install -g jison```
|
||||
* Git-utils: ```npm install git-utils -g ```
|
||||
* FontForge
|
||||
|
||||
Installing prerequisite components (once):
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user