Skip to content

Commit

Permalink
Fix README and remove unnecessary commands
Browse files Browse the repository at this point in the history
The README was simplified and the example to install the
Snippy tool was removed. The original intention was to
highlight that the plugin and tool must be installed into
the same Python namespace (local or global) to find the
plugins. Then it was thought that the default README has
to be as simple and short as possible without any bloat.

Signed-off-by: Heikki Laaksonen <laaksonen.heikki.j@gmail.com>
  • Loading branch information
heilaaks committed Jun 15, 2019
1 parent c295af4 commit 5e867d6
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,14 @@ To import defined tldr man pages remotely, run:

.. code:: text
pip install snippy --user
snippy import --plugin tldr --file https://github.com/tldr-pages/tldr/tree/master/pages/osx
To import defined tldr man pages locally, run:

.. code:: text
mkdir ${HOME}/tmp && cd $_
git clone https://github.com/tldr-pages/tldr.git
pip install snippy --user
snippy import --plugin tldr --file file:.tldr/pages/linux
snippy import --plugin tldr --file file:./tldr/pages/linux
.. _Snippy: https://github.com/heilaaks/snippy

Expand Down

0 comments on commit 5e867d6

Please sign in to comment.