Skip to content

Commit

Permalink
Adding .gitattributes + documentation enhancements
Browse files Browse the repository at this point in the history
1. Added .gitattributes file to avoid problems line endings.
2. Added docimentation on how to update Hoggorm from command line
Quickstart-part of documenation.
  • Loading branch information
olivertomic committed Dec 21, 2017
1 parent d902c01 commit 20c4a63
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
17 changes: 17 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Auto detect text files and perform LF normalization
* text=auto

# Custom for Visual Studio
*.cs diff=csharp

# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
15 changes: 14 additions & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,11 @@ Make sure that Python 3.5 or higher is installed. A convenient way to install Py
- numpy


Installation and updates
------------------------

Installation
------------
++++++++++++

Install Hoggorm easily from the command line from the `PyPI - the Python Packaging Index`_.

Expand All @@ -35,6 +38,16 @@ Install Hoggorm easily from the command line from the `PyPI - the Python Packagi
pip install hoggorm
Updating
++++++++

To update Hoggorm from an previously installed oudated version execute the following from the command line:

.. code-block:: bash
pip install --update hoggorm
If you need more information on how to install Python packages using pip, please see the `pip documentation`_.

.. _pip documentation: https://pip.pypa.io/en/stable/#
Expand Down

0 comments on commit 20c4a63

Please sign in to comment.