Add instructions to install Kalamine

alexherbo2 commented 4 years ago

Hi kaze,

I would like to revive #11 to add install instructions.

It is especially useful for people who want to make packages and NixOS users.

Dependencies
--------------------------------------------------------------------------------

* Python_ (>= 3.8)
* pip_
* Setuptools_
* libxml2_
* libxslt_

.. _Python: https://python.org
.. _pip: https://pip.pypa.io
.. _Setuptools: https://pypi.org/project/setuptools/
.. _libxml2: http://xmlsoft.org
.. _libxslt: http://xmlsoft.org

Installation
--------------------------------------------------------------------------------

.. code-block:: sh

    pip install --user kalamine

NixOS
`````

.. code-block:: sh

    nix-shell --packages python38 python38Packages.pip python38Packages.setuptools libxml2 libxslt --run 'pip install --user kalamine'

JulioJu commented 4 years ago

@alexherbo2 thanks for your instructions :-)

chambln commented 2 years ago

I had to figure this out on my own yesterday and these instructions would have been very helpful. Is there a reason this has not been merged?

devnoname120 commented 1 year ago

My fork has a Poetry package file: https://github.com/qwerty-fr/kalamine/blob/master/pyproject.toml

How to use:

poetry install
poetry run kalamine qwerty-ansi.yaml

lobre commented 1 year ago

Just to mention that I just opened the following issue because I am packaging kalamine into nix.

https://github.com/fabi1cazenave/kalamine/issues/28

I received instructions directly from @fabi1cazenave to build it from source (and it is rather simple to build). I am not far from submitting the PR on nixpkgs. I will link it in my above issue once done.

OneDeadKey / kalamine

Add instructions to install Kalamine #8