fontship

Sobre la fuente

Fontship es un conjunto de herramientas para generar fuentes y herramientas para un flujo de trabajo colaborativo.

Desarrollado en la liga de tipo móvil con las necesidades de los proyectos de fuentes de código abierto en mente, Fontship automatiza el proceso de convertir sus fuentes de diseño en archivos de fuentes listos para la producción y agruparlos para su publicación. Sí, podría tomar los mismos pasos manualmente. Sí, podría escribir sus propios guiones para realizar el mismo trabajo. Lo que la fuente trae a la mesa es un paquete completo de todas las herramientas que necesita reunir con la mayoría de los bits conectados.

Una construcción de fuentes de fuentes está completamente automatizada, las compilaciones automáticas de CI y las versiones de publicación están a solo un pequeño paso de distancia. Como una ventaja adicional, todo está cuidadosamente organizado para hacer que la colaboración remota asincrónica a través de sistemas de control de versiones (como GIT) sea lo más fácil posible. ¡Los diseñadores ni siquiera necesitan usar las mismas herramientas de diseño!

Casi todos los aspectos de los pasos de compilación y el flujo de trabajo se pueden ajustar por proyecto, pero la configuración fuera de la caja debería funcionar para construir la mayoría de los proyectos de fuentes.

Configuración

La fuente se puede utilizar de cualquiera de las tres maneras diferentes:

1. Remotamente a través de un corredor de CI que responde a los eventos en un repositorio de git remoto.
2. Localmente a través de una imagen Docker con todo incluido para una configuración de baja molestia.
3. Localmente a través de una instalación de utilidad de sistema regular (siempre que todas las dependencias requeridas también estén instaladas).

Nota: Se ha desagradado un cuarto método admitido a través de V0.5.0, la inclusión directa de los archivos de reglas de Fontship en el makefile existente de su proyecto. Dependiendo de su proyecto, dicho uso puede continuar funcionando con limitaciones por el momento, pero se asumirán nuevas características agregadas a la CLI en las reglas en el futuro.

Configuración de CI

¡Construya sus fuentes sin instalar ni ejecutar nada localmente! Simplemente empuje sus fuentes a un repositorio de git remoto y deje que Fontship haga el resto.

Para usar con acciones de GitHub, agregue un archivo de configuración a su repositorio, como .github/workflows/fontship.yml :

 name : Fontship
on : [push, pull_request]
jobs :
  fontship :
    runs-on : ubuntu-latest
    name : Fontship
    steps :
      - name : Checkout
        uses : actions/checkout@v2
        with :
          fetch-depth : 0
      - name : Fetch tags
        run : git fetch --prune --tags
      - name : Fontship
        uses : theleagueof/fontship@latest

En el momento actual, la fuente solo construye las fuentes en el directorio actual del proyecto, no las publica en ningún lado. Deberá publicar los artefactos resultantes (por ejemplo, adjuntándolos a cada ejecución del CI o publicándolos en versiones) como otro paso del flujo de trabajo de su proyecto. Para ver los ejemplos de trabajo completos, consulte los flujos de trabajo de la liga Spartan o Libertinus.

Otros corredores de CI podrían ser compatibles fácilmente, consulte el número 32 para más detalles o para solicitar configuraciones de muestra para su favorito.

Configuración de Docker

Las imágenes de Docker prebuilt están disponibles en Docker Hub, paquetes de GitHub, o puede construirlas usted mismo.

La forma más fácil de instanciar un contenedor Docker con todos los argumentos correctos es establecer un alias (que se puede agregar al archivo RC de su shell para persistirlo):

Usando Docker Hub como ejemplo, un alias podría ser:

$ alias fontship= ' docker run -it --volume "$(pwd):/data" --user "$(id -u):$(id -g)" theleagueof/fontship:latest '

Docker tirará automáticamente los contenedores que debe ejecutar esto la primera vez que lo use, después de lo cual solo usará su caché de contenedores local. Para saltar, comience la descarga sin ejecutar fontship o para actualizar manualmente su caché más tarde (por ejemplo, cuando las últimas se actualen a una nueva versión) Use docker pull theleagueof/fontship:latest .

Puede sustituir a lo último (que siempre será la etiqueta de versión lanzada más recientemente) con Master para usar la construcción inédita más fresca, con un nombre de etiqueta como V0.3.2 para usar explícitamente una versión específica, o con la cabeza para usar una imagen construida localmente.

Para construir una imagen de Docker localmente, querrá clonar este repositorio y ejecutar ./bootstrap.sh o descargar y extraer las fuentes de una versión, luego ejecutar:

$ ./configure
$ make docker

Configuración del sistema

Si usa Arch Linux, puede instalar este paquete AUR (preconstruido en este repositorio).

De lo contrario, para instalar y usar localmente desde la fuente, necesitará algunas dependencias:

• Git,
• GNU Core Utilities Plus diffutils , bsdtar , entr , zsh ,
• GNU make (4.2+) con las herramientas de autoconf correspondientes,
• Python 3 más módulos variados, ver requisitos.txt archivo,
• Herramientas de óxido que incluyen cargo y rustc para construir la CLI,
• Y un puñado de otras utilidades de CLI relacionadas con fuentes, a saber: sfnt2woff-zopfli , psautohint , ttfautohint y woff2_compress .

Para instalar el software en su computadora, clone este repositorio y ejecute ./bootstrap.sh o descargue y extraiga la última versión, luego ejecute:

$ ./configure
$ make
$ sudo make install

Uso

Edificio

Para construir todos los formatos posibles para su proyecto de fuente, ejecute

$ fontship make all

Para generar solo un formato específico, intente:

# Just static OTF fonts
$ fontship make otf

# All static formats
$ fontship make static

# All variable formats
$ fontship make variable

# Just variable TTF format
$ fontship make variable-ttf

Si solo está interesado en un archivo específico (por ejemplo, una instancia de peso estático), puede especificar el nombre exacto del archivo que espera obtener la reconstrucción más rápida posible de ese archivo:

$ fontship make FooBar-Black.otf

Publicación

Cuando todo está listo o desea enviar una fuente (o enviar una muestra a un amigo), querrá construir el paquete de distribución:

$ fontship make dist

Versiones

La configuración de la versión de fuente en todas las fuentes generadas está determinada por la etiqueta en el repositorio de Git. Las etiquetas de versión deben ajustarse al formato MAJOR.MINOR descrito por OpenFV.