Skip to content
README.rst 1.53 KiB
Newer Older
Nimrod Adar's résumé
nimrod's avatar
nimrod committed
====================
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
.. image:: https://git.shore.co.il/nimrod/resume/badges/nimrod/pipeline.svg
    :target: https://git.shore.co.il/nimrod/resume/-/commits/nimrod
nimrod's avatar
nimrod committed
    :alt: pipeline status

A tiny framework to generate your résumé from whatever markup that
suits you (and that Pandoc can read).
My own résumé is in the :code:`nimrod` branch, the outputed files can be found
in my `about me <https://www.shore.co.il/blog/pages/about-me.html>`_ page.

nimrod's avatar
nimrod committed
Dependencies
------------

- `Docker <https://www.docker.com/>`_ (for building).
- rsync (for uploading).
nimrod's avatar
nimrod committed

Usage
-----

The various settings (input file, server name to upload, etc.) are specified in
the :code:`Makefile`, adjust according to your needs.

nimrod's avatar
nimrod committed
To build the pdf version (same for odt, html, docx)
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
.. code:: shell
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
    docker run -itv "$PWD:/project" registry.shore.co.il/presentation make pdf
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
To build all versions
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
.. code:: shell
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
    docker run -itv "$PWD:/project" registry.shore.co.il/presentation make
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
To upload to webserver (includes rebuilding all versions)
nimrod's avatar
nimrod committed

nimrod's avatar
nimrod committed
.. code:: shell
nimrod's avatar
nimrod committed

    make publish

License
-------

nimrod's avatar
nimrod committed
This repository is licensed under the `Creative Commons
nimrod's avatar
nimrod committed
Attribution 4.0 International (CC BY 4.0) license
nimrod's avatar
nimrod committed
<http://creativecommons.org/licenses/by/4.0/>`_ (see :code:`LICENSE.txt`)
nimrod's avatar
nimrod committed

Author
------

Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
nimrod's avatar
nimrod committed
at: https://git.shore.co.il/explore.