Skip to content

Commit

Permalink
Merge branch 'develop' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
KjellMorgenstern authored Dec 16, 2019
2 parents 33a7810 + b9d8552 commit 121f30b
Show file tree
Hide file tree
Showing 87 changed files with 4,581 additions and 2,723 deletions.
40 changes: 40 additions & 0 deletions INSTALL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Installing Fritzing

Please make sure your system satisfies one of these requirements:
Windows 10
Windows 7 was reported to work, too
Mac - OSX 10.14 and up, though 10.13 might work too. MacOS 10.15 is currently untested.
Linux - a fairly recent linux distro with libc >= 2.6

Start downloading the Fritzing package that's right for you.
Unzip your Fritzing folder somewhere convenient on your hard drive.
This may also be a good time for you to create a shortcut to the Fritzing application.
A free unzipping program can be found here, should you need it.

## Notes on Windows

Unzipping Fritzing might be very slower than the download itself. We recommend
using 7zip

To start Fritzing on Windows: double-click fritzing.exe

## Notes on Linux
To start Fritzing double-click Fritzing, or try ./Fritzing in your shell window

Fritzing uses the Qt5 libraries. On Ubuntu, they can be installed like this:

"sudo apt install libqt5xml5 libqt5sql5 libqt5serialport5"


## Notes on macOS
To start Fritzing on macOS double-click the Fritzing application

Recent versions of macOS do not allow "unverified" software to be launched directly. In order to run Fritzing, you will need to either:

1a. right-click the Fritzing icon and select "Open"
2a. in the warning dialog, click "Open"
or, to get rid of the warning permanently:
1b. go to the System Preferences
2b. open the Security & Privacy page
3b. unlock it by clicking the lock in the lower left corner
4b. set it to allow app downloads from anywhere
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,21 @@ The Fritzing application is an Electronic Design Automation software with a low
* To report a problem or suggest improvements, use the [issue tracker](https://github.com/fritzing/fritzing-app/issues) or the [user forum](http://forum.fritzing.org).
Please provide steps, what operating system you are on, including the version. Add screenshots or copies of error messages, describe what behavior you saw and what you expected.

* If you would like to help with the development, please take a look at the [developer instructions](https://github.com/fritzing/fritzing-app/wiki). This includes information about how to compile and run the Fritzing app in a few steps.
* If you would like to help with the development, please take a look at those labels:
* [![label: easy start][~easy start]](https://github.com/fritzing/fritzing-app/labels/easy%20start)
* [![label: challenging start][~challenging start]](https://github.com/fritzing/fritzing-app/labels/challenging%20start)

Some of those don't need C++ skills, like reproducing an issue on a certain platform, or verifying translations of languages we don't speak. If there is something for you, you might want to check the [developer instructions](https://github.com/fritzing/fritzing-app/wiki) next. This includes information about how to compile and run the Fritzing app.

## Project Structure

* **help** - End-user documentation included with the app. This should really be moved back to the website.
* **help** - End-user documentation included with the app.

* **parts** - All the part definitions, including meta data (.fzp) and graphics (.svg), as well as some utility tools. They are kept in a separate repository at [https://github.com/fritzing/fritzing-parts](http://github.com/fritzing/fritzing-parts) and only linked from here.

* **pri** - Submodule definitions for Qt

* **config.tests** - Files needed by Qt to determine if the boost is installed. See README there.

* **resources** - Binaries and definitions that are supposed to not be touched by users, such as fonts, images, special parts, etc.
* **resources** - Binaries and definitions that are supposed not to be touched by users, such as fonts, images, special parts, etc.

* **sketches** - Example circuits/sketches shipped with the application

Expand All @@ -40,16 +42,20 @@ The Fritzing app was maintained by the Friends-of-Fritzing e.V., a non-profit fo

The founding team consists of Prof. Reto Wettach, André Knörig, Jonathan Cohen, and Stefan Hermann. Many [fantastic people](http://fritzing.org/about/people/) have contributed to it over the years.

Since 2019, the project is maintained by Kjell Morgenstern, with great support from Peter Van Epp, André Knörig and AISLER.
Since 2019, the project is maintained by Kjell Morgenstern, with great support from Peter Van Epp, André Knörig, and AISLER.

The Fritzing app is written on top of the [Qt cross-platform framework](http://qt-project.org).

## Licensing

The source code of Fritzing is licensed under GNU GPL v3, the documentation and part designs under Creative Commons Attribution-ShareALike 3.0 Unported. The full text of these licenses are shipped with this download.
The source code of Fritzing is under GNU GPL v3, the documentation and part designs under Creative Commons Attribution-ShareALike 3.0 Unported. The full texts of these licenses are shipped with this download.

This means that you can create your own variation of Fritzing, as long as you credit us and also publish it under GPL. Similarly, you may re-publish our documentation, as long as you credit us, and publish it under the same
license. You may publish circuits and diagrams that you create with Fritzing and that use our graphics, again as long as you credit us, and
publish your works under the same license. A credit can be as simple as "this image was created with Fritzing."

Look up [our FAQs](http://fritzing.org/faq/) for more details on licensing.
Lookup [our FAQs](http://fritzing.org/faq/) for more details on licensing.

[~help wanted]: https://img.shields.io/badge/-help%20wanted-%23159818
[~easy start]: https://img.shields.io/badge/-easy%20start-%2333AAFF
[~challenging start]: https://img.shields.io/badge/-challenging%20start-%235500EE
Loading

0 comments on commit 121f30b

Please sign in to comment.