leocad/docs/README.md

79 lines
2.3 KiB
Markdown
Raw Normal View History

# About LeoCAD
2011-09-07 23:06:51 +02:00
2021-03-22 02:17:49 +01:00
LeoCAD is a CAD program for creating virtual LEGO(R) models. It's available
2018-01-16 04:47:25 +01:00
for free under the GNU Public License v2 and works on the Windows, Linux
and macOS Operating Systems.
2011-09-07 23:06:51 +02:00
# Installation
2011-09-07 23:06:51 +02:00
2014-03-11 23:30:49 +01:00
You can download the latest version of LeoCAD and its Parts Library from
2018-03-14 19:00:58 +01:00
the main website at https://www.leocad.org
2011-09-07 23:06:51 +02:00
2014-03-11 23:30:49 +01:00
It's recommended that you install the latest drivers for your video card
since LeoCAD uses OpenGL to take advantage of hardware acceleration for
rendering.
2011-09-07 23:06:51 +02:00
## LeoCAD for Windows
2011-09-07 23:06:51 +02:00
2020-12-24 20:52:57 +01:00
Download the latest LeoCAD-Windows.exe to your computer, double click on
2021-01-14 15:26:11 +01:00
the icon to launch the installer and follow the instructions.
2011-09-07 23:06:51 +02:00
## LeoCAD for Linux
2011-09-07 23:06:51 +02:00
There are multiple ways to install LeoCAD on Linux.
2021-01-30 17:10:48 +01:00
* Snap Store
2021-03-22 02:17:49 +01:00
You can find LeoCAD in your distribution's Snap Store. Alternatively, you
can enter `sudo snap install leocad` to install it using the command line.
2021-01-30 17:10:48 +01:00
* AppImage
2014-03-11 23:30:49 +01:00
2021-03-22 02:17:49 +01:00
Download the latest LeoCAD-Linux.AppImage, make the file executable
(`chmod +x`) and run it.
* Flatpak
2021-01-30 17:10:48 +01:00
You can also install LeoCAD releases as a Flatpak from Flathub:
https://flathub.org/apps/details/org.leocad.LeoCAD
Note: there might be a delay for new releases to appear there. If
you have it already installed, it will be updated.
* From source
2021-01-30 17:10:48 +01:00
2018-03-14 19:00:58 +01:00
If you prefer to compile LeoCAD yourself, go to the GitHub releases page
2021-01-30 17:10:48 +01:00
at https://github.com/leozide/leocad/releases/latest and download the
2018-03-14 19:00:58 +01:00
source archive from there. If you do not already have a Parts Library
installed, you will need to download one and follow the installation
instructions. More information on how to compile your own executable is
available in the Documentation section of https://www.leocad.org
2011-09-07 23:06:51 +02:00
## LeoCAD for macOS
2013-08-14 06:31:39 +02:00
2020-12-24 20:52:57 +01:00
Download the latest LeoCAD-macOS.dmg to your computer, double click on
the icon to open the archive, copy LeoCAD.app to your Applications folder
and then launch it from there.
2013-08-14 06:31:39 +02:00
2018-03-14 19:00:58 +01:00
New users should read the online tutorial located at
https://www.leocad.org/docs/tutorial1.html to learn how to use LeoCAD.
2011-09-07 23:06:51 +02:00
# Online Resources
2011-09-07 23:06:51 +02:00
- Website:
2018-03-14 19:00:58 +01:00
https://www.leocad.org
2011-09-07 23:06:51 +02:00
2017-02-09 02:54:30 +01:00
- GitHub page:
https://github.com/leozide/leocad
2011-09-07 23:06:51 +02:00
2020-12-24 20:50:47 +01:00
- Unstable builds:
https://github.com/leozide/leocad/releases/tag/continuous
2011-09-07 23:06:51 +02:00
# Legal Disclaimer
2011-09-07 23:06:51 +02:00
2018-02-10 03:19:20 +01:00
LEGO(R) is a trademark of the LEGO Group of companies which does not sponsor,
2011-09-07 23:06:51 +02:00
authorize or endorse this software.