diff --git a/PKGBUILD b/PKGBUILD index 66364863..c1fb03b7 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -35,7 +35,7 @@ package() { mkdir -p ${pkgdir}/usr/bin mkdir -p ${pkgdir}/usr/share/leocad install -m 755 build/release/leocad ${pkgdir}/usr/bin - install -m 644 docs/README.txt ${pkgdir}/usr/share/leocad/README.txt + install -m 644 docs/README.md ${pkgdir}/usr/share/leocad/README.md install -m 644 docs/CREDITS.txt ${pkgdir}/usr/share/leocad/CREDITS.txt install -m 644 docs/COPYING.txt ${pkgdir}/usr/share/leocad/COPYING.txt mkdir -p ${pkgdir}/usr/share/mime/packages/ diff --git a/appveyor.yml b/appveyor.yml index cc5d66c2..bbbf6e35 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -25,7 +25,7 @@ after_build: - 7z a symbols.zip build/release/leocad.exe build/release/leocad.pdb - mkdir appdir - copy build\release\leocad.exe appdir -- copy docs\readme.txt appdir +- copy docs\readme.md appdir - appveyor DownloadFile https://github.com/leozide/leocad/releases/download/v19.07.1/Library-20.03.zip -FileName library.zip - 7z e library.zip - copy library.bin appdir\\library.bin diff --git a/docs/README.txt b/docs/README.md similarity index 82% rename from docs/README.txt rename to docs/README.md index a16ff5a7..0c3402bb 100644 --- a/docs/README.txt +++ b/docs/README.md @@ -1,13 +1,11 @@ -About LeoCAD ------------- +# About LeoCAD LeoCAD is a CAD program for creating virtual LEGO models. It's available for free under the GNU Public License v2 and works on the Windows, Linux and macOS Operating Systems. -Installation ------------- +# Installation You can download the latest version of LeoCAD and its Parts Library from the main website at https://www.leocad.org @@ -16,21 +14,24 @@ 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. -- LeoCAD for Windows: +## LeoCAD for Windows Download the latest LeoCAD-Windows.exe to your computer, double click on the icon to launch the installer and follow the instructions. -- LeoCAD for Linux: +## LeoCAD for Linux - There are multiple ways to install LeoCAD on Linux. +There are multiple ways to install LeoCAD on Linux. - * AppImage: +* Snap Store + + 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. - Download the latest LeoCAD-Linux.AppImage, make the file executable - (chmod +x) and run it. +* AppImage - * Flatpak: + Download the latest LeoCAD-Linux.AppImage, make the file executable (`chmod +x`) and run it. + +* Flatpak You can also install LeoCAD releases as a Flatpak from Flathub: https://flathub.org/apps/details/org.leocad.LeoCAD @@ -38,7 +39,7 @@ rendering. Note: there might be a delay for new releases to appear there. If you have it already installed, it will be updated. - * From source: +* From source If you prefer to compile LeoCAD yourself, go to the GitHub releases page at https://github.com/leozide/leocad/releases/latest and download the @@ -47,7 +48,7 @@ rendering. instructions. More information on how to compile your own executable is available in the Documentation section of https://www.leocad.org -- LeoCAD for macOS: +## LeoCAD for macOS 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 @@ -57,8 +58,7 @@ New users should read the online tutorial located at https://www.leocad.org/docs/tutorial1.html to learn how to use LeoCAD. -Online Resources ----------------- +# Online Resources - Website: https://www.leocad.org @@ -70,8 +70,7 @@ Online Resources https://github.com/leozide/leocad/releases/tag/continuous -Legal Disclaimer ----------------- +# Legal Disclaimer LEGO(R) is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this software. diff --git a/leocad.pro b/leocad.pro index f72270e6..89a5cc23 100644 --- a/leocad.pro +++ b/leocad.pro @@ -111,7 +111,7 @@ unix:!macx { target.path = $$BIN_DIR docs.path = $$DOCS_DIR - docs.files = docs/README.txt docs/CREDITS.txt docs/COPYING.txt + docs.files = docs/README.md docs/CREDITS.txt docs/COPYING.txt man.path = $$MAN_DIR man.files = docs/leocad.1 desktop.path = $$DESKTOP_DIR diff --git a/leocad.spec b/leocad.spec index a487eeb3..530966f9 100644 --- a/leocad.spec +++ b/leocad.spec @@ -239,7 +239,7 @@ install -d $RPM_BUILD_ROOT%{_datadir}/icons/hicolor/scalable/mimetypes install -d $RPM_BUILD_ROOT%{_datadir}/icons/hicolor/scalable/apps install -d $RPM_BUILD_ROOT%{_mandir}/man1 install -m 755 build/release/leocad $RPM_BUILD_ROOT%{_bindir}/leocad -install -m 644 docs/README.txt $RPM_BUILD_ROOT%{_datadir}/leocad/README.txt +install -m 644 docs/README.md $RPM_BUILD_ROOT%{_datadir}/leocad/README.md install -m 644 docs/CREDITS.txt $RPM_BUILD_ROOT%{_datadir}/leocad/CREDITS.txt install -m 644 docs/COPYING.txt $RPM_BUILD_ROOT%{_datadir}/leocad/COPYING.txt install -m 644 docs/leocad.1 $RPM_BUILD_ROOT%{_mandir}/man1/leocad.1 @@ -264,7 +264,7 @@ install -m 644 resources/leocad.svg \ %endif %{_bindir}/leocad %dir %{_datadir}/leocad -%doc %{_datadir}/leocad/README.txt +%doc %{_datadir}/leocad/README.md %doc %{_datadir}/leocad/CREDITS.txt %doc %{_datadir}/leocad/COPYING.txt %{_datadir}/mime/packages/leocad.xml diff --git a/tools/setup/leocad.nsi b/tools/setup/leocad.nsi index 50d61cf8..740b4dd4 100644 --- a/tools/setup/leocad.nsi +++ b/tools/setup/leocad.nsi @@ -106,7 +106,7 @@ Section "Uninstall" Delete "$INSTDIR\LeoCAD.exe" Delete "$INSTDIR\LeoCAD.hlp" Delete "$INSTDIR\LeoCAD.cnt" - Delete "$INSTDIR\readme.txt" + Delete "$INSTDIR\readme.md" Delete "$INSTDIR\library.bin" Delete "$INSTDIR\povconsole32-sse2.exe" Delete "$INSTDIR\vc_redist.x64.exe"