Skip to content

Commit 848f670

Browse files
author
Katie Horne
committed
add tutorial on PyCharm
1 parent edb0820 commit 848f670

File tree

1 file changed

+34
-15
lines changed

1 file changed

+34
-15
lines changed

getting-started/pycharm.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ changes.
4444

4545
## Step 2: Create your workspace
4646

47-
You will now create the workspace where you'll work on your development project.
47+
You will now create the workspace to work on your development project.
4848

4949
1. Return to **Workspaces** using the top navigation bar.
5050

@@ -63,9 +63,9 @@ You will now create the workspace where you'll work on your development project.
6363
machine** option is selected, _unselect_ the box. Leave the **CPU**,
6464
**Memory**, **Disk**, and **GPU** allocations as-is.
6565

66-
1. Scroll to the bottom, and click **Create workspace**. The dialog will close,
67-
allowing you to see the main workspace page. You can track the workspace
68-
build process using the **Build log** on the right-hand side.
66+
1. Scroll to the bottom and click **Create workspace**. The dialog will close,
67+
allowing you to see the main workspace page. On the right-hand side, you can
68+
track the workspace build process using the **Build log**.
6969

7070
![Create a workspace](../assets/getting-started/create-workspace-pycharm.png)
7171

@@ -79,23 +79,28 @@ purposes of this article, we'll leverage JetBrains' tutorial on how to
7979
[Create and run your first Python project](https://www.jetbrains.com/help/pycharm/creating-and-running-your-first-python-project.html).
8080

8181
1. Under **Browser applications**, click **PyCharm Community** to open the IDE
82-
in your browser.
82+
in your browser. Follow the prompts to accept the license agreement and
83+
determine data sharing permissions.
8384

84-
1. On the Welcome screen, click **New Project**.
85+
1. On the **Welcome to PyCharm** screen, click **New Project**.
8586

8687
1. In the window that pops up:
8788

88-
1. Provide the **Location** where PyCharm should save your files.
89+
1. Provide the **Location** where PyCharm should save your files (for this
90+
example, we changed the highlighted portion to `task`, but you can name
91+
the folder whatever you'd like))
8992
1. Ensure that **New environment using Virtualenv** is selected.
9093
1. Make sure to **uncheck** the option to **Create a main.py welcome
9194
script**.
9295
1. Click **Create** to proceed.
9396

9497
1. In the left-hand navigation bar, right-click on the **root** of your folder
95-
and select **New** > **File**. When prompted, provide a name for your file.
98+
(for example, if you named the folder `task`, you would click where it says
99+
**task** in the navbar) and select **New** > **File**. When prompted, provide
100+
a name for your file (e.g., `car.py`).
96101

97-
1. The IDE automatically opens your file, allowing you to edit. Copy and paste
98-
the following
102+
1. The IDE automatically opens your new, empty file, allowing you to edit. Copy
103+
and paste the following
99104
[sample app from JetBrains](https://www.jetbrains.com/help/pycharm/creating-and-running-your-first-python-project.html#edit-file):
100105

101106
```python
@@ -156,19 +161,33 @@ purposes of this article, we'll leverage JetBrains' tutorial on how to
156161

157162
## Step 5: Push your repo to GitHub
158163

159-
The follow steps show you how to push your app to a newly created GitHub repo.
164+
The following steps show you how to push your app to a newly created GitHub
165+
repo.
160166

161167
1. Log in to GitHub and navigate to
162168
[Create a new repository](https://github.com/new).
163169

164170
1. Provide a **repository name** and click **Create repository**.
165171

166-
1. Return to your workspace, run the following in your terminal to add a remote
167-
to your GitHub repo, change the primary branch name to `main`, and push the
168-
contents to your newly created repo:
172+
1. Return to your workspace, and click **Terminal** at the bottom.
173+
174+
1. Run the following to turn your directory into a Git repository and commit
175+
your initial changes:
176+
177+
```console
178+
cd ..
179+
git init <nameOfDirectory>
180+
cd <nameOfDirectory>
181+
git add -A
182+
git commit -am "Initial commit"
183+
```
184+
185+
1. Run the following in your terminal to add a remote to your GitHub repo,
186+
change the primary branch name to `main`, and push the contents to your newly
187+
created repo:
169188

170189
```console
171-
git remote add origin https://github.com/<username>/<repoName>.git
190+
git remote add origin git@github.com:<username>/<repoName>.git
172191
git branch -M main
173192
git push origin main
174193
```

0 commit comments

Comments
 (0)