Code Monkey home page Code Monkey logo

kicad-website's Introduction

KiCad Website Source

This the source for the new KiCad website, anno 2015.

LICENSE

The kicad-website repository is dual licensed. You may distribute it and/or modify it under the terms of either the GNU General Public License (http://www.gnu.org/licenses/gpl.html), version 3 or later, or the Creative Commons Attribution License (http://creativecommons.org/licenses/by/3.0/), version 3.0 or later.

Prerequisites

You will need these packages:

  • hugo version 0.69.0 (you must use this version!)

  • ruby (to use asciidoctor)

  • asciidoctor version 2.0.10

Using asciidoctor is a requirement, because the original asciidoc runs into trouble parsing the adoc files with TOML headers in them. asciidoctor also has a few extra features for web pages.

Testing

Execute the hugo command in the repository root to build and serve the files for development:

hugo server -w -v

Observe the console output as it will tell you the address where the page is accessible in a browser. The -w flag tells it to watch the filesystem for changes to rebuild automatically. Also, the page in the browser will autorefresh once the rebuild completes successfully.

Contributing

Please read the CONTRIBUTING Guidelines

Docker

A dockerfile is included that builds and packages the website with an nginx instance

Hints

Admonition icons

For icons to appear in admonition blocks, you must add

:icons:
:iconsdir: /img/icons/

at the top of the asciidoc file but below the hugo template header.

adoc partials

Please name any reusable asciidoc files with a leading underscore in the filename and ending in .adoc. Hugo is configured to ignore such files on purpose.

External resources

To enhance security a little, we implement Content-Security-Policy headers which are set by nginx. These dictate to the browser what resource paths are allowable for scripts, videos, images, etc And while we do use HTTPS, CSP is just another tool to potentially stop browser side and other attacks.

This means: 1. Please add any images, js and css directly to this repo. Its far better for us to mirror them lest they potentially go down in the future. Especially third party images 2. Please make best effort to use existing "approved" remote resources as visibile in /.docker/default.conf 3. If you notice a resource isn’t loading on what you are editing, check the Developer Tools Console output for your respective browser, if it is blocked due to CSP, it will say so.

kicad-website's People

Contributors

adamwolf avatar antoniomr avatar bombledmonk avatar bpjwes avatar caerbannog avatar carycode avatar cpresser avatar craftyjon avatar diegoherranz avatar eldarkg avatar evanshultz avatar hildogjr avatar imciner2 avatar jemtech avatar jkriege2 avatar jsreynaud avatar leon-anavi avatar lkundrak avatar marekr avatar nickoe avatar nitrousnrg avatar orsonmmz avatar poeschlr avatar rdmitry avatar reportingsjr avatar schrodingersgat avatar stambaughw avatar stevefalco avatar thor-arne avatar tijuca avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

kicad-website's Issues

KLC: Require IPC-compliant significant digits?

@poeschlr
If you read the IPC-7351 "Land Pattern Naming Convention Notes", it specifies the following:

  • All dimensions are in Metric Units
  • All Lead Span and Height numbers go two places past the decimal point and “include” trailing Zeros
  • All Lead Span and Body Sizes go two place before the decimal point and “remove” leading Zeros
  • All Chip Component Body Sizes are one place to each side of the decimal point
  • Pitch Values are two places to the right & left of decimal point with no leading Zeros but include trailing zeros

In KLC, G1.9 covers the first bullet.

I'm concerned with the second, third, and fifth bullets. I don't see KLC specifying the significant digits but we probably should. It would not only conform with KLC, but remove ambiguity and should be easy enough to catch in a check script.

If you're updating KLC, and agree, you could add a significant digits requirement where appropriate. I assume F2.1 would be the right place and it needs a few updates to meet the significant digits specification above.

Kicad will not load PCBNEW just crashes

The error:-
An assertion failed
../src/common/object.cpp(251): assert "classTable->Get(m_className) == NULL" failed in Register(): Class "wxCommandEvent" already in RTTI table - have you used IMPLEMENT_DYNAMIC_CLASS() multiple times or linked some object file twice)?
What does all his mean, can you help.
Kicad 4.0.7
Debian 9
my name, Isaac Shields Email; [email protected]
I did have a black screen trouble, I have fixed that but now the kicad not working

Git instructions on developer page

Folks, git-bzr is no longer available under Fedora, having been replaced by git-remote-bzr. This package is also available on Ubuntu, and is a different script than the one you are currently referencing.

I started doing the changes to reflect this on the page, but ended up with a glaring problem: git-remote-bzr does not allow you to push to a non-existant branch in bzr (as done in the example).

Suggestion to either change everything over to git-remote-bzr to have a unified setup and try to get them to add this feature while documenting a workaround, or to document the install process of git-bzr-ng on Fedora.

I can do either of those, but would be good to know if there are preferences.

Need a custom 404

We definitely need a custom 404 page with a single click to the homepage.
This requires some server configuration to use 404.html, which is currently empty.

This is especially important since most inbound links are now broken... Just try googling for KiCad.

Please provide an AppImage for Linux

Providing an AppImage would have, among others, these advantages:

  • Applications packaged as an AppImage can run on many distributions (including Ubuntu, Fedora, openSUSE, CentOS, elementaryOS, Linux Mint, and others)
  • One app = one file = super simple for users: just download one AppImage file, make it executable, and run
  • No unpacking or installation necessary
  • No root needed
  • No system libraries changed
  • Works out of the box, no installation of runtimes needed
  • Optional desktop integration with appimaged
  • Optional binary delta updates, e.g., for continuous builds (only download the binary diff) using AppImageUpdate
  • Can optionally GPG2-sign your AppImages (inside the file)
  • Works on Live ISOs
  • Can use the same AppImages when dual-booting multiple distributions
  • Can be listed in the AppImageHub central directory of available AppImages
  • Can double as a self-extracting compressed archive with the --appimage-extract parameter

Here is an overview of projects that are already distributing upstream-provided, official AppImages.

A while back I had made some test AppImages, see the discussion here:
https://forum.kicad.info/t/kicad-appimage-for-linux/4963/7
Note that this was just a quick proof-of-concept. While I do not have the time (nor KiCad knowledge) to maintain an AppImage build myself, I'd be happy to help the KiCad project setting one up.

If you have questions, AppImage developers are on #AppImage on irc.freenode.net.

Unable to do apt-get install kicad

Have a system on a rockchip ....aarch64 running ubuntu xenial 16.04.3 LTS and can get all of the ancillary packages but cannot do a apt-get install for kicad.

Error is as follows;
Package kicad is not available, but is referred to by another package.
This may mean that the package is missing, has been obsoleted, or
is only available from another source

E: Package 'kicad' has no installation candidate

Yes I have added this repository to pull from....

Hit:1 http://ppa.launchpad.net/js-reynaud/kicad-4/ubuntu xenial InRelease
Hit:3 http://ppa.launchpad.net/js-reynaud/ppa-kicad/ubuntu xenial InRelease

According to the package list all the rest are marked "all" and I can get but kicad labeled "arm64" and seems I can't get it. Thank you as I also have armhf and x86 system which all seem to work. I am trying to replace my Eagle systems. This particular one I use as I travel....Normally in NZ.

[email protected]

Licensing addition - need agreement

We need to license the website to match the kicad documentation.
https://github.com/KiCad/kicad-doc

This means it will be under dual license of GNU General Public License (http://www.gnu.org/licenses/gpl.html) version 3 or later, and the Creative Commons Attribution License (http://creativecommons.org/licenses/by/3.0/).

Please reply to this github issue that you approve of licensing your
contribution(s) to the website repository as such. Otherwise (hopefully not) we'll have to remove them.

@nickoe
@Caerbannog
@reportingsjr
@orsonmmz
@adamwolf
@rdmitry
@mithro
@ataffanel
@mattvenn
@jemtech
@Thor-Arne ✅ (via email)
@cpavlina ✅
@tfboy
@OnkartGromt
@mangelajo
@marcos-paltatech
@ricardocrudo ✅

http://kicad-pcb.org/contribute/developers/

According to the instructions on
http://kicad-pcb.org/contribute/developers/

  1. you download the kicad source and create a feature branch
  2. Before you create the patch you do an update of the "master" branch "kicad"
    and then update your featur-branch with "bzr merge ../kicad" (oarund the middle of the home page)
    next command is "bzr diff > feature.patch"

however if you follow the instructions straight from the homepage "bzr diff" would not generate
anything (it is already committed)

My suggestion (to be consistent to the instructions och creatign a feature branch and the update/commits) is to change

"bzr diff > feature.patch"
into
"bzr diff --old ../kicad > feature.patch"

EEschema symbol flip

I have identified an abnormal behavior when editing the properties of a symbol.

To highlight it, just click twice on the symbol, the window where you can mirror the symbol appears.

Under "Position" item select Mirror vertically. The result will be a Horizzontally mirrored symbol.
Double click again on symbol. Meanwhile in the "Position" item, Mirror Horizzontally will become active.
Select again Mirror vertically and finally you will get a vertically mirrored symbol.

OS: Fedora 27 x86_64
Kicad : Nightly build

Application: kicad
Version: 5.0.0-rc2-dev-unknown, debug build
Libraries:
wxWidgets 3.0.2
libcurl/7.55.1 OpenSSL/1.1.0g zlib/1.2.11 libidn2/2.0.4 libpsl/0.18.0 (+libidn2/2.0.3) libssh2/1.8.0 nghttp2/1.25.0
Platform: Linux 4.15.4-300.fc27.x86_64 x86_64, 64 bit, Little endian, wxGTK
Build Info:
wxWidgets: 3.0.2 (wchar_t,wx containers,compatible with 2.8) GTK+ 2.24
Boost: 1.64.0
Curl: 7.55.1
Compiler: GCC 7.3.1 with C++ ABI 1011
Build settings:
USE_WX_GRAPHICS_CONTEXT=OFF
USE_WX_OVERLAY=OFF
KICAD_SCRIPTING=OFF
KICAD_SCRIPTING_MODULES=OFF
KICAD_SCRIPTING_WXPYTHON=OFF
KICAD_SCRIPTING_ACTION_MENU=OFF
BUILD_GITHUB_PLUGIN=ON
KICAD_USE_OCE=OFF
KICAD_SPICE=OFF

Chromebook?

Has anyone successfully ported this to chromebook?

feature request 3d pcb view to stl file export

it seems to be missing the 3d pcb view exportable in a 3d format like stl so it can be imported to blender , openscad and other cad packages as its usefull for when creating an enclosure ie mounting points cut outs for connectors and such

Library: Better how to contribute section required

The how to contribute section could benefit from a rework.

  1. One thing to add would be a link to the repos to which pull requests should be made
  2. Another thing to change is removing old unused communication channels. (I don't think any of the current librarians use IRC. so we should not write it such that the users get the idea that we guarantee to be reachable via that channel)

Title case and/or wording of tag line

The tag line it at least mildly incorrect:

A Cross Platform And Open Source Electronics Design Automation Suite

At very least, "And" should be "and" by convention. I was going to just submit a PR, but really, I'm not fond of how long this is in general, it feels awkward to me. So I thought I'd ask. What about this?

Cross Platform and Open Source Electronics Design

Or

Cross Platform, Open Source Electronics Design

We could even omit "Cross Platform" - most large open source projects these days are.

To me, it seems awkward how the tagline flows into the next line - particularly breaking in the middle of an "important" phrase, I don't like "Electronics \ Design Automation" being split like that:

http://misc.c4757p.com/tagline.png

Thoughts?

Hard to find link to this issue tracker

It is difficult to find out where to report problems with the website. I suggest that a small section is added to the "Home -> Help -> Report a bug" page on the main website, pointing to the kicad website issue tracker.

As it is now, it is not obvious that you should go to "Contribute -> Docs team" to report a bug on the website.

Error changing value, example resistance

I've been drawing small schemas with version 4.07 for a long time, always OK. For some time there is a mistake: I can also change the value of a resistor, or other parts. If I want to continue then sometimes it goes again, then it's over. Save project, close, reopen and you can continue this way, 1 or 2 object. This happens with the Windows 10 version, on the latest version. I have then tried the same project on the Linux machine Mint 18.2, there it works flawlessly. So I can draw the schema on Windows is fine, to determine the values I have to do it on Linux. There is version 4.02, older version.
I translated everything with Google because my English is minimal, I can understand datasheets, but I have to translate a text.
I think the idea of KiCad is good, that's why I reported the error. Is there a job in Germany where you could also report it?
Best regards
Michel
my Email: [email protected]

Installation error Windows 7 32bit

After downloading KiCad for Windows 32bit computer I try to install and get an error message.
error
I have tried installing on 2 different 32 bit PC's and get same result.

Wrong aspect ratio of F4.1a.png when rendered

The image at the end of the F5.1 paragraph has a wrong rendered aspect ratio, despite the original file (/img/klc/F4.1a.png - BTW, the filename is inconsistent with the paragraphs numbering) is correct. See the attached screenshot.

screenshot-2017-12-17 kicad eda

Rendered on Firefox 57.0.2 / Win64

URLs are absolute, domain has no www

This does not cause any problem as far as I can tell, but most links use absolute URLs, for instance here is the generated HTML for a menu link:

<a href="http://kicad-pcb.org/post/">

Most cases could be replaced by the following, which seem more conventional to me:

<a href="/post/">

Benefits:

  • Shorter text
  • Serving HTTPS and HTTP simultaneously will be easier
  • Does not depend on a specific hostname
    Is there a reason not to change this? I would be happy to do the work.

Another subject is the canonical domain name, which used to be www.kicad-pcb.org, but has dropped the www. today. Is this intentional, and should we adapt the documentation?

Documentation and website are unreadable

The KiCad PDF documents (March 2, 2016) as well as the web site are a faint gray
and very difficult to read. I can use an add-on to fix the web pages but I'm finding
the PDFs a show-stopper to picking up KiCad.

I know that projects like KiCad take accessibility issues seriously and that they can
often be difficult to work out but this one is very simple to get right.

I'll refer to the W3.org Web Content Accessibility Guidelines as a helpful reference:
https://www.w3.org/TR/2016/NOTE-UNDERSTANDING-WCAG20-20161007/visual-audio-contrast-contrast.html

1.4.3 Contrast (Minimum): The visual presentation of text and images of text has
a contrast ratio of at least 4.5:1

Thanks for your consideration. This would be a big help.

KiCad - Schematic Grid Size

Hi,

I have completed the Schematic in KiCad. Later I have noticed about the Grid Size, it was wrong. I would like to change the Grid Size. But for that I need to redraw the Schematics. Is there any other way to change the Schematic Grid Size rather than doing from the scratch?

Could you please help me to resolve this issue?

Spanish KiCad translation an forum

Hello,

A couple of notes...

  • The KiCad Spanish translation was featured on hackaday.com (first message
    ever in Spanish on hackaday). Maybe it is of interest to publish it on the
    KiCad webpage in the (DISCOVER->IN THE MEDIA) section.

Link:
http://hackaday.com/2016/02/11/kicad-traducido-al-espanol/

  • There has been some interest among some users about a Spanish forum about
    KiCad, so I published one here: www.elektroquark.com/forokicad. It's
    starting now but, could it be linked from the COMMUNITY section?

Best regards.

Top bar covers headlines after clicking link

On http://kicad-pcb.org/help/documentation/ there is a list of sections to click. Clicking on one of those will cause the page to scroll down to the relevant documentation. However, it scrolls the title to the top of the page, but then the title is hidden by the top bar, causing some confusion. The attached illustrations explains this better.

This is when clicking "Pcbnew":
now

This is what I would have expected when clicking "Pcbnew":
expected

adopt rules for "made with kicad" projects to provide source files?

@nickoe

We have a few made with kicad projects that don't provide kicad source files or any source files really. At a minimum I say gerbers should be available. We should probably define this as policy.

Projects:
CSEduino (i swear there was something before, now theres no 0 reference to kicad and no of course no files)
Crazyflie, it appears no actual source files are shared for kicad, just printed PDFs. I don't even think Gerbers are avaliable. Even their "kicad library" page on their wiki is blank.
EITI: No source files, looks like commerical page now.
Electrosmart: no source files

@stambaughw

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.