diff --git a/README_dev.md b/README_dev.md index 5ae3190..5ebf2e2 100644 --- a/README_dev.md +++ b/README_dev.md @@ -7,36 +7,36 @@ Hi! Welcome to this Python Template, this `README_dev.md` contains instructions 2. Find the green button on the top-right that says "Use this template," and create a new repository with your ``. 3. Clone the repository using the green "<> Code" button, copy the SSH link 4. Locally, on your PC, navigate to the folder in which you want the repository to be placed using `cd`. (tip: one can use Tab for auto-completion and double Tab to list all options) -5. Clone the repository. (tip: copy-pasting in terminal can be done using: cntrl-shift-v) +5. Clone the repository. Tip 1: copy-pasting in terminal can be done using: cntrl-shift-v. Tip 2: the arrows `< >` are not required but added here as they are a standard notation form to indicate that there one should enter text) ```bash git clone ``` -6. Navigate into the cloned repository ( +6. Navigate into the cloned repository ```bash - cd \ + cd ``` -7. Time to create our first commit using git, first one should add all the changes. It is important to always do this from the root folder of your repository, to check what will be tracked you can use `git status`. +7. It's time to create our first commit using git; this starts with adding (or staging) the changes. It is important always to do this from the root folder of your repository, to check what will be tracked you can use `git status`. ```bash git add . ``` -8. Once the changes are staged, they should be committed with a commit message, e.g. "initial commit". (The `-m` is called a flag, indicating that the commit message will follow. For this message, the arrows `< >` are not required but added here as they are a standard notation form to indicate that there one should enter text) +8. Once the changes are staged, they should be committed with a commit message, e.g. "initial commit". The `-m` is called a flag, indicating that the commit message will follow. ```bash git commit -m "" ``` -9. The commited changes are now saved on locally, and should be pushed to the remote (to Github). You can verify this worked, by checking the GitHub repository online. +9. The committed changes are now saved locally and should be pushed to the remote (to Github). You can verify this worked by checking the GitHub repository online. ```bash git push ``` -10. Create a virtual environment (this is a folder in your project, in which all the required external packages ('dependencies') are stored) +10. Create a virtual environment. The venv is a folder in your project in which all the required external packages ('dependencies') are stored) ```bash python -m venv venv ``` -11. Activate the virtual environment, this should result in a (venv) in your terminal, indicating the virtual-environment is active. +11. Activate the virtual environment; this should result in a (venv) in your terminal, indicating the virtual environment is active. Tip: for proper dependency management, one should **always activate the venv before coding**. ```bash source venv/bin/activate ``` -12. you can now open this folder with your favorite code editor (IDE, e.g. VSCode) and start coding! -13. Once you are finished you can deactivate the venv using, don't forget next-time you start coding to activate the venv once more +12. Open this folder with your favorite code editor (IDE, for example VSCode) and start coding! +13. Once you are finished you can deactivate the venv ```bash deactivate ```