Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename Doc to docs to use GitHub Pages and change Readme.md to docs folder #15

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
54 changes: 1 addition & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,56 +6,4 @@ KiCad_BOM_Wizard can either be integrated into KiCad’s BOM plugin manager for

KiCad_BOM_Wizard comes with three templates examples, one for generate HTML BOMs, one for generating a CSV BOM and the final one for generating PDF BOMs.

---
### Author
Ronald Sousa [hashdefineelectronics.com](http://hashdefineelectronics.com)

Twitter: [@Opticalworm](https://twitter.com/Opticalworm) [@HashDefineElec](https://twitter.com/HashDefineElec)

### Project Information
- Repository: [github.com](https://github.com/HashDefineElectronics/KiCad_BOM_Wizard.git)

- Project Page: [hashdefineelectronics.com](http://hashdefineelectronics.com/kicad-bom-wizard/)

- Forum: [kiCad.info](https://forum.kicad.info/t/kicad-bom-wizard-plugin-with-customisable-output-can-make-html-and-csv-bom/2142/7?u=opticalworm)

- Coding Standard
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

___

# Video Instructions
[![Using KiCad Bom Wizard Plugin](http://img.youtube.com/vi/JlaQqHQE1Ec/0.jpg)](https://youtu.be/JlaQqHQE1Ec)
___

# Install and Setup

To use KiCad_BOM_Wizard, you will need [NodeJs](https://nodejs.org/en/) and [NPM](https://www.npmjs.com/) installed and configured in your system.

There are two options for installing and using KiCad_BOM_Wizard.

#### 1. github download method
This method if for anyone who's new to git and rather download the project directly from github.

- [github download method](./Doc/git_download_install.md).

#### 2. git clone method
This method if for anyone who prefers to use git.

This is particularly useful if you are planning on using git submodule to keep a copy of KiCad_BOM_Wizard per KiCad projects.

- [git clone method](./Doc/git_clone_install.md).

---
# Short codes

These are the list of short code that are used in the template files.

[Shortcode cheatsheet - shortcode.md](./Doc/shortcode.md)

---
# Frequently asked question
Pleased don't forget to checkout the [FAQ.md](./FAQ.md) document if you have any issue with the document.

---
##### For more details on how to use your own template for KiCad_BOM_Wizard then head over to the [project Homepage](http://hashdefineelectronics.com/kicad-bom-wizard/).
More Informations in [./docs/](./docs)
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-architect
61 changes: 61 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# KiCad BOM Wizard Plugin

KiCad_BOM_Wizard is nodeJs script for generating custom KiCad BOMs. It uses template files to describe and define the content of the output.

KiCad_BOM_Wizard can either be integrated into KiCad’s BOM plugin manager for easier use or executed directly via your system's terminal.

KiCad_BOM_Wizard comes with three templates examples, one for generate HTML BOMs, one for generating a CSV BOM and the final one for generating PDF BOMs.

---
### Author
Ronald Sousa [hashdefineelectronics.com](http://hashdefineelectronics.com)

Twitter: [@Opticalworm](https://twitter.com/Opticalworm) [@HashDefineElec](https://twitter.com/HashDefineElec)

### Project Information
- Repository: [github.com](https://github.com/HashDefineElectronics/KiCad_BOM_Wizard.git)

- Project Page: [hashdefineelectronics.com](http://hashdefineelectronics.com/kicad-bom-wizard/)

- Forum: [kiCad.info](https://forum.kicad.info/t/kicad-bom-wizard-plugin-with-customisable-output-can-make-html-and-csv-bom/2142/7?u=opticalworm)

- Coding Standard
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

___

# Video Instructions
[![Using KiCad Bom Wizard Plugin](http://img.youtube.com/vi/JlaQqHQE1Ec/0.jpg)](https://youtu.be/JlaQqHQE1Ec)
___

# Install and Setup

To use KiCad_BOM_Wizard, you will need [NodeJs](https://nodejs.org/en/) and [NPM](https://www.npmjs.com/) installed and configured in your system.

There are two options for installing and using KiCad_BOM_Wizard.

#### 1. github download method
This method if for anyone who's new to git and rather download the project directly from github.

- [github download method](./Doc/git_download_install.md).

#### 2. git clone method
This method if for anyone who prefers to use git.

This is particularly useful if you are planning on using git submodule to keep a copy of KiCad_BOM_Wizard per KiCad projects.

- [git clone method](./Doc/git_clone_install.md).

---
# Short codes

These are the list of short code that are used in the template files.

[Shortcode cheatsheet - shortcode.md](./Doc/shortcode.md)

---
# Frequently asked question
Pleased don't forget to checkout the [FAQ.md](./FAQ.md) document if you have any issue with the document.

---
##### For more details on how to use your own template for KiCad_BOM_Wizard then head over to the [project Homepage](http://hashdefineelectronics.com/kicad-bom-wizard/).
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-architect
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.