From c8d2163a794d717a02b7d0e43daa29765348bb53 Mon Sep 17 00:00:00 2001 From: lukkea Date: Mon, 12 Oct 2020 12:20:38 +0100 Subject: [PATCH] moved dev profile advise to general notes and, hopefully, improved wording --- README.development | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/README.development b/README.development index d1a19a96e..403c1902b 100644 --- a/README.development +++ b/README.development @@ -97,6 +97,28 @@ system install, you will need to set up the pyenv folder yourself, making sure you have PyQt5, the WebEngine module and development tools (eg pyqt5-dev-tools) installed as well. You'll need to create the venv with --system-site-packages. +Studying Anki on your Dev machine? +---------------------------------- +It's advisable to create a new Anki dev profile for debug and testing so that your study collection doesn't become +incompatible with your installed version: + - run Anki + - File | Switch profile > Add > provide [dev profile name] > Ok + - make a note of that [dev profile name] + +Because you now have at least two profiles the Profiles dialog will open when Anki runs to allow you to choose the +profile to load. + +Alternatively you can set your Anki project to load your [dev profile name] profile automatically with the startup +options described here: https://docs.ankiweb.net/#/files?id=startup-options + +To do this in PyCharm: + - right click on the "run" file in the root of the PyCharm Anki folder + - click "Edit 'run'..." + - in Script options enter: + - "-p [dev profile name]" + - without the quotes + - click "Ok" + Debian/Ubuntu users ------------------- @@ -163,10 +185,6 @@ These notes are proscriptive, other methods will work (such as a different Bash/ While some of this list is in an arbitrary order, significant steps are in a specific order, therefore it is strongly recommended to follow these instructions step-by-step. -- if you study Anki in the same environment as you develop software: - - create a new Anki profile so that your decks aren't "upgraded" to the dev version - - make a note of that [dev profile name] - - Python and PyCharm are a given if you are choosing this path and should be the first and second step respectively. - close PyCharm, if it's open. @@ -245,14 +263,6 @@ While some of this list is in an arbitrary order, significant steps are in a spe - add .idea folder to your global .gitignore (not the local .gitignore in the cloned repo) -- if you study Anki in the same environment as you develop software: - - right click on the "run" file in the root of the PyCharm Anki folder - - click "Edit 'run'..." - - in Script options enter: - - "-p [dev profile name]" - - without the quotes - - click "Ok" - - from project root run: - pip install -r qt/requirements.qt