Skip to content

Commit

Permalink
fix(git): Added git to troubleshooting guide #112 (#158)
Browse files Browse the repository at this point in the history
The git rename main branch to master error is caused by older versions
of git.
The error has a quick fix, running the extra overhead of checking git
versions and workarounds is not warranted.

closes #112
  • Loading branch information
imAsparky committed Nov 11, 2021
1 parent 951c41d commit 76aa274
Showing 1 changed file with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions docs/source/troubleshooting.rst
Expand Up @@ -2,35 +2,30 @@
Trouble Shooting
================

*Copyright 2015, Audrey Roy Greenfeld*

.. note:: Can you help improve this file? `Edit this file`_
and submit a pull request with your improvements!


.. _`Edit this file`: https://github.com/imAsparky/cookiecutter-py3-package/blob/main/docs/troubleshooting.rst


Windows Issues
--------------
GIT Issues
----------

* Some people have reported issues using git bash; try using the Command
Terminal instead.
After generating your cookiecutter-py3-package, you get this error message
in the command line.

* Virtual environments can sometimes be tricky on Windows. If you have Python
3.6 or above installed (recommended), this should get you a virtualenv named
``myenv`` created inside the current folder:
.. code-block::
.. code-block:: powershell
error: refname refs/heads/master not found
fatal: Branch rename failed
> c:\Python36\python -m venv myenv
Or:
This error message is caused by using older versions of git.

.. code-block:: powershell

> c:\Python36\python c:\Python35\Tools\Scripts\pyvenv.py myenv
You have several options.

* Some people have reported that they have to re-activate their virtualenv
whenever they change directory, so you should remember the path to the
virtualenv in case you need it.
#. Follow the git manual instructions :ref:`here<git-CLI-push-GIT-options>`
substituting the example with your repository and project.
#. Upgrade git and re-run the cookie-cutter.

0 comments on commit 76aa274

Please sign in to comment.