freetype-commit
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Git][freetype/freetype][gsoc-anurag-docs-2023] [docs] Migrate docs/INST

From: Anurag Thakur (@AdbhutDev)
Subject: [Git][freetype/freetype][gsoc-anurag-docs-2023] [docs] Migrate docs/INSTALL to Markdown
Date: Thu, 29 Jun 2023 11:46:54 +0000

Anurag Thakur pushed to branch gsoc-anurag-docs-2023 at FreeType / FreeType

Commits:

  • 58edcae3
    by Anurag Thakur at 2023-06-29T17:16:38+05:30 
    [docs] Migrate docs/INSTALL to Markdown

3 changed files:

Changes:

  • README.md
    ... ... @@ -154,7 +154,7 @@ and accept it fully.
    154 154 
     [Documentation GZ]: https://download.savannah.gnu.org/releases/freetype/freetype-2.11.1.tar.gz
    155 155 
     [Documentation ZIP]: https://download.savannah.gnu.org/releases/freetype/ftdmo2111.zip
    156 156
    157 
    -[INSTALL]: ./docs/INSTALL
    157 
    +[INSTALL]: ./docs/INSTALL.md
    158 158 
     [CHANGES]: ./docs/CHANGES
    159 159 
     [LICENSE]: ./LICENSE.TXT
    160 160 
     [DOCGUIDE]: ./docs/DOCGUIDE

  • docs/.gitignore
    ... ... @@ -5,6 +5,8 @@ reference/
    5 5 
     *.html
    6 6 
     *.md
    7 7
    8 
    +!INSTALL.md
    9 
    +
    8 10 
     # MkDocs Config file
    9 11 
     mkdocs.yml
    10 12

  • docs/INSTALL → docs/INSTALL.md
    1 
    +# Building FreeType
    1 2
    2 3 
     There are  several ways  to build the  FreeType library,  depending on
    3 4 
     your system and the level of  customization you need.  Here is a short
    4 5 
     overview of the documentation available:
    5 6
    6 7
    7 
    -I. Prerequisites and dependencies
    8 
    -=================================
    8 
    +## A. Prerequisites and dependencies
    9 9
    10 10 
       FreeType is a low level C library  that only depends on the standard
    11 11 
       C library with very few platform-dependent optimizations utilized at
    ... ... @@ -24,10 +24,9 @@ I. Prerequisites and dependencies
    24 24 
       run-time;  look at the documentation of function `FT_Property_Set`.
    25 25
    26 26
    27 
    -II. Normal installation and upgrades
    28 
    -====================================
    27 
    +## B. Normal installation and upgrades
    29 28
    30 
    -  1. Unix and Unix-like systems
    29 
    +1. Unix and Unix-like systems
    31 30
    32 31 
         This also includes MacOS, Cygwin, MinGW + MSYS, Mingw-w64 + MSYS2,
    33 32 
         and possibly other, similar environments.
    ... ... @@ -40,7 +39,7 @@ II. Normal installation and upgrades
    40 39 
         GNU Make VERSION 3.81 OR NEWER IS NEEDED!
    41 40
    42 41
    43 
    -  2. Other systems using GNU Make
    42 
    +2. Other systems using GNU Make
    44 43
    45 44 
         On some  non-Unix platforms, it  is possible to build  the library
    46 45 
         using only  the GNU Make utility.   Note that *NO OTHER  MAKE TOOL
    ... ... @@ -51,19 +50,20 @@ II. Normal installation and upgrades
    51 50 
         Instructions are provided in the file `INSTALL.GNU`.
    52 51
    53 52
    54 
    -  3. Other build tools and platforms.
    53 
    +3. Other build tools and platforms.
    55 54
    56 55 
         A few other tools  can be used  to build FreeType.  You  can  find
    57 56 
         the  corresponding instruction files  in  the FreeType root folder
    58 57 
         or the builds/ sub-folder.
    59 58
    60 
    -      CMake   :: see `CMakeLists.txt` for more information
    61 
    -      Meson   :: see `meson.build` for more information
    62 
    -      MSBuild :: see `builds/windows/vc2010/freetype.vcxproj`
    63 
    -      MMS     :: see `vms_make.com` and `docs/INSTALL.VMS`
    59 
    +| --- | ---|
    60 
    +|CMake   | see `CMakeLists.txt` for more information |
    61 
    +|Meson   | see `meson.build` for more information |
    62 
    +|MSBuild | see `builds/windows/vc2010/freetype.vcxproj` |
    63 
    +|MMS     | see `vms_make.com` and `docs/INSTALL.VMS` |
    64 64
    65 65
    66 
    -  4. With an IDE Project File (e.g., for Visual Studio or CodeWarrior)
    66 
    +4. With an IDE Project File (e.g., for Visual Studio or CodeWarrior)
    67 67
    68 68 
         We provide a  small number of 'project files'  for various IDEs to
    69 69 
         automatically build  the library as  well.  Note that  these files
    ... ... @@ -74,22 +74,63 @@ II. Normal installation and upgrades
    74 74 
         directory, where <system> stands for your OS or environment.
    75 75
    76 76
    77 
    -  5. From you own IDE, or own Makefiles
    77 
    +5. From you own IDE, or own Makefiles
    78 78
    79 79 
         If  you  want  to  create   your  own  project  file,  follow  the
    80 80 
         instructions   given  in  the   `INSTALL.ANY`  document   of  this
    81 81 
         directory.
    82 82
    83 83
    84 
    -III. Custom builds of the library
    85 
    -=================================
    84 
    +## C. Custom builds of the library
    86 85
    87 86 
       Customizing the compilation  of FreeType is easy, and  allows you to
    88 87 
       select only the components of  the font engine that you really need.
    89 88 
       For more details read the file `CUSTOMIZE`.
    90 89
    90 
    +## D. Standard builds with `configure`
    91 91
    92 
    -----------------------------------------------------------------------
    92 
    +  The git repository doesn't contain pre-built configuration scripts for
    93 
    +  UNIXish platforms.  To generate them say
    94 
    +
    95 
    +    sh autogen.sh
    96 
    +
    97 
    +  which in turn depends on the following packages:
    98 
    +
    99 
    +    automake (1.10.1)
    100 
    +    libtool (2.2.4)
    101 
    +    autoconf (2.62)
    102 
    +
    103 
    +  The versions given  in parentheses are known to  work.  Newer versions
    104 
    +  should  work too,  of course.   Note  that `autogen.sh`  also sets  up
    105 
    +  proper file permissions for the `configure` and auxiliary scripts.
    106 
    +
    107 
    +  The `autogen.sh` script checks whether the versions of the above three
    108 
    +  tools match the numbers above.  Otherwise it will complain and suggest
    109 
    +  either  upgrading or  using  environment variables  to  point to  more
    110 
    +  recent versions of the required tools.
    111 
    +
    112 
    +  Note that  `aclocal` is provided  by the 'automake' package  on Linux,
    113 
    +  and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
    114 
    +
    115 
    +
    116 
    +## E. Alternative build methods
    117 
    +
    118 
    +  For static  builds that don't use  platform-specific optimizations, no
    119 
    +  configure script is necessary at all; saying
    120 
    +
    121 
    +    make setup ansi
    122 
    +    make
    123 
    +
    124 
    +  should work on all platforms that have GNU `make` (or `makepp`).
    125 
    +
    126 
    +  A build  with `cmake`  or `meson`  can be done  directly from  the git
    127 
    +  repository.  However, if you want  to use the `FT_DEBUG_LOGGING` macro
    128 
    +  (see file `docs/DEBUG` for more information) it is currently mandatory
    129 
    +  to execute `autogen.sh`  in advance; this script clones  the 'dlg' git
    130 
    +  submodule and copies some files into FreeType's source tree.
    131 
    +
    132 
    +
    133 
    +---
    93 134
    94 135 
     [1] make++, a make tool written in Perl, has sufficient support of GNU
    95 136 
         make extensions to build FreeType.  See
    ... ... @@ -99,7 +140,7 @@ III. Custom builds of the library
    99 140 
         for more information;  you need version 2.0 or newer, and you must
    100 141 
         pass option `--norc-substitution`.
    101 142
    102 
    -----------------------------------------------------------------------
    143 
    +---
    103 144
    104 145 
     Copyright (C) 2000-2023 by
    105 146 
     David Turner, Robert Wilhelm, and Werner Lemberg.
    ... ... @@ -110,5 +151,3 @@ license, LICENSE.TXT. By continuing to use, modify, or distribute
    110 151 
     this file you  indicate that you have read  the license and understand
    111 152 
     and accept it fully.
    112 153
    113 
    -
    114 
    ---- end of INSTALL ---

    • —
    View it on GitLab.
    You're receiving this email because of your account on gitlab.freedesktop.org. Manage all notifications · Help

    reply via email to
    [Prev in Thread] Current Thread [Next in Thread]