Skip to content

Commit eba0cea

Browse files
committed
Some more native speaker proofreading
Gave the 'database', 'code editor', 'Django installation' and 'Start a Django Project' pages a quick linguistic overhaul.
1 parent e66eb2b commit eba0cea

4 files changed

Lines changed: 90 additions & 71 deletions

File tree

code_editor/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# Code editor
22

3-
You're about to create your first file of code, so it's time to download a code editor!
3+
You're about to write your first line of code, so it's time to download a code editor!
44

5-
There is a lot of different ones and it really depends on your needs. Most Python programmers use complex, but super powerful IDEs (Integrated Development Environment), like PyCharm. But for you, as a beginner, we're recommending something simple, yet powerful.
5+
There are a lot of different editors and it largely boils down to personal preference. Most Python programmers use complex but extremely powerful IDEs (Integrated Development Environments), such as PyCharm. As a beginner, however - that's probably less suitable; our recommendations are equally powerful, but a lot more simple.
66

7-
Our suggestions are below, but feel free to ask your coach what is their preference, as it'll be easier to get help from them :)
7+
Our suggestions are below, but feel free to ask your coach what their preference is - it'll be easier to get help from them.
88

99
## Gedit
1010

1111
Gedit is an open-source, free editor, available for all operating systems.
1212

13-
[Download it here.](https://wiki.gnome.org/Apps/Gedit#Download)
13+
[Download it here](https://wiki.gnome.org/Apps/Gedit#Download)
1414

1515
## Sublime Text 2
1616

17-
Sublime Text is a very popular editor with a free evaluation period (you can use it for free as long as you need, but it'd be good to buy a license some day :)). It's easy to install and use, available for all operating systems.
17+
Sublime Text is a very popular editor with a free evaluation period. It's easy to install and use, and available for all operating systems.
1818

19-
[Download it here.](http://www.sublimetext.com/2)
19+
[Download it here](http://www.sublimetext.com/2)
2020

2121
## Atom
2222

23-
Atom is rather new code editor created by [Github](http://github.com/). It's free, open-sourced, easy to install and use editor, but available only for Mac OS X for now. It'll be available for other systems in the future.
23+
Atom is an extremely new code editor created by [GitHub](http://github.com/). It's free, open-source, easy to install and easy to use, but is only available as a prebuilt program on Windows and OS X at the moment. It'll be available prebuilt for Linux in the future.
2424

25-
[Download it here.](https://atom.io/)
25+
[Download it here](https://atom.io/)

database/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,73 @@
11
# Database
22

3-
Most of web applications have their own database. A database is a collection of data. This is a place in which you will store all information about users, all your blog post texts, etc..
3+
Most web applications have their own database. A database is a collection of data. This is a place in which you will store information about users, your blog posts, etc.
44

5-
We will be using a PostgreSQL database to store our data. It would be easier to use a default Django database called *sqlite*, but it's not good for production use (by *production* we mean: real, running websites). If you want to have your application available in the Internet, not only on your computer, you will need PostgreSQL.
5+
We will be using a PostgreSQL database to store our data. It would be easier to use the default Django database adapter - called *sqlite* - but it's not good for production use. *Production* means out on the big, scary internet - running real websites accessed by more than a handful of users. If you want your application to be available to the world, not just running on your computer, you'll need PostgreSQL.
66

77
# PostgreSQL installation
88

99
## Windows
1010

11-
PostgreSQL is recommending to install it using a program you can find here: http://www.enterprisedb.com/products-services-training/pgdownload#windows
11+
The easiest way to install Postgres on Windows is using a program you can find here: http://www.enterprisedb.com/products-services-training/pgdownload#windows
1212

13-
Choose a newest version available for your operating system. Download this Installer, run it and then follow the instructions available here: http://www.postgresqltutorial.com/install-postgresql/. Take note of the installation directory, you will need it in the next step (most likely it will be `C:\Program Files\PostgreSQL\9.3`).
13+
Choose the newest version available for your operating system. Download the installer, run it and then follow the instructions available here: http://www.postgresqltutorial.com/install-postgresql/. Take note of the installation directory as you will need it in the next step (typically, it's `C:\Program Files\PostgreSQL\9.3`).
1414

1515
## Mac OS X
1616

17-
The easiest way is to download a free [Postgres.app](http://postgresapp.com/) and install it like any other application on your operating system.
17+
The easiest way is to download the free [Postgres.app](http://postgresapp.com/) and install it like any other application on your operating system.
1818

19-
Go ahead, download it, drag to the Applications folder and run by double clicking. That's it!
19+
Download it, drag to the Applications folder and run by double clicking. That's it!
2020

2121
## Linux
2222

23-
Of course, installation depends on Linux distribution. We've added most popular ones, but if you can't find yours, [here are all the tutorials](https://wiki.postgresql.org/wiki/Detailed_installation_guides#General_Linux).
23+
Installation steps vary from distribution to distribution. Below are the commands for Ubuntu and Fedora, but if you're using a different distro [take a look at the PostgreSQL documentation](https://wiki.postgresql.org/wiki/Detailed_installation_guides#General_Linux).
2424

2525
### Ubuntu
2626

27-
Go to your console and run a following command:
27+
Run the following command:
2828

2929
sudo apt-get install postgresql postgresql-contrib
3030

3131
### Fedora
3232

33+
Run the following command:
34+
3335
sudo yum install postgresql93-server
3436

3537
# Create database
3638

37-
Now we need to create our database user and our first database. You can add many databases in PostgreSQL, so if you have more than one website, you should have a separate database for each one!
39+
Next up, we need to create our first database, and a user that can access that database. PostgreSQL lets you create as many databases and users as you like, so if you're running more than one site you should create a database for each one.
3840

3941
## Windows
4042

41-
If you're using Windows, there is a little bit more we need to do. For now you don't need to understand these steps, but feel free to ask your coach if you're curious!
43+
If you're using Windows, there's a couple more steps we need to complete. For now it's not important for you to understand the configuration we're doing here, but feel free to ask your coach if you're curious as to what's going on.
4244

4345
1. Open the Command Prompt (Start menu → All Programs → Accessories → Command Prompt)
44-
2. Type the following `setx PATH "%PATH%;C:\Program Files\PostgreSQL\9.3\bin"` (you can also paste things into the Command Prompt by right clicking and selecting `Paste`). Make sure that the path is the same as you noted during installation with `\bin` added at the end. You should see the message `SUCCESS: Specified value was saved.`.
45-
3. Close the Command Prompt and it open again.
46+
2. Run the following by typing it in and hitting return: `setx PATH "%PATH%;C:\Program Files\PostgreSQL\9.3\bin"`. You can paste things into the Command Prompt by right clicking and selecting `Paste`. Make sure that the path is the same one you noted during installation with `\bin` added at the end. You should see the message `SUCCESS: Specified value was saved.`.
47+
3. Close and then reopen the Command Prompt.
4648

4749
## Create the database
4850

49-
First, let's make our console into postgres mode by typing `psql`. Remember the part about console?
50-
>On Mac OS X you can do this by launching the `Terminal` application (it's in Applications → Utilities). On Linux, it's probably under Applications → Accessories → Terminal. On Windows you need to go to Start menu → All Programs → Accessories → Command Prompt. Further, on Windows, `psql` might require logging in using the username and password you chose during installation. If `psql` is asking you for password and doesn't seem to work, try `psql -U <username> -W` first and enter the password later.
51+
First, let's launch the Postgres console by running `psql`. Remember how to launch the console?
52+
>On Mac OS X you can do this by launching the `Terminal` application (it's in Applications → Utilities). On Linux, it's probably under Applications → Accessories → Terminal. On Windows you need to go to Start menu → All Programs → Accessories → Command Prompt. Furthermore, on Windows, `psql` might require logging in using the username and password you chose during installation. If `psql` is asking you for a password and doesn't seem to work, try `psql -U <username> -W` first and enter the password later.
5153
5254
$ psql
5355
psql (9.3.4)
5456
Type "help" for help.
5557
#
5658

57-
Our `$` now changed into `#`, it means that we're now giving commands to PostgreSQL. Let's create a user:
59+
Our `$` now changed into `#`, which means that we're now sending commands to PostgreSQL. Let's create a user:
5860

5961
# CREATE USER name;
6062
CREATE ROLE
6163

62-
Of course, replace `name` with your own name. Remember that you should not use diacritic letters and whitespaces, i.e. `bożena maria` is invalid! You need to transform it into `bozena_maria`.
64+
Replace `name` with your own name. You shouldn't use accented letters or whitespace (e.g. `bożena maria` is invalid - you need to convert it into `bozena_maria`).
6365

6466
Now it's time to create a database for your Django project:
6567

6668
# CREATE DATABASE djangogirls OWNER name;
6769
CREATE DATABASE
6870

69-
Remember to replace `name` with the name you've chosen (i.e. `bozena_maria`).
70-
71-
Awesome! All ready!
72-
71+
Remember to replace `name` with the name you've chosen (e.g. `bozena_maria`).
7372

73+
Great - that's databases all sorted!

django_installation/README.md

Lines changed: 43 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,37 @@
44

55
## Virtual environment
66

7-
Before we will install Django, we will make you install something very, very handy and useful, that will help you keeping everything tidy on your computer. It is possible to skip this step, but we think, that you should start with the best setup possible to save a lot of troubles in the future!
7+
Before we install Django, we'll get you to install an extremely useful tool that will help keep your coding environment tidy on your computer. It's possible to skip this step, but it's highly recommended not to - starting with the best possible setup will save you a lot of trouble in the future!
88

9-
That's why, we want you to create a Virtual environment (also called `virtualenv`). It will isolate things you do from your computer, so you will have everything important in one place. Neat, right?
9+
So, let's create a **virtual environment** (also called a *virtualenv*). It will isolate your Python/Django setup on a per-project basis, meaning that any changes you make to one website won't affect any others you're also developing. Neat, right?
1010

11-
All you need to do is finding a folder in which you want to create the `virtualenv`, for example your home directory. In Windows it could look like: `C:\Users\Name\` (where `Name` is a name of the user).
11+
All you need to do is find a folder in which you want to create the `virtualenv`; your home directory, for example. On Windows it might look like `C:\Users\Name\` (where `Name` is the name of your login).
1212

1313
### Windows
1414

15-
To create a new `virtualenv` you need to open the console (we already told you how to open it, remember?) and type there `C:\Python\python -m venv blog`. It will look like this:
15+
To create a new `virtualenv`, you need to open the console (we told you about that a few tutorials ago - remember?) and run `C:\Python\python -m venv blog`. It will look like this:
1616

1717
C:\Users\Name> C:\Python34\python -m venv blog
1818

19-
where `C:\Python34\python` is folder in which you previously installed Python and `blog` is a name of your `virtualenv`. You can use any other name, but stick to lowercase and use no spaces. It is also good idea to keep the name short :).
19+
where `C:\Python34\python` is the folder in which you previously installed Python and `blog` is a name of your `virtualenv`. You can use any other name, but stick to lowercase and use no spaces. It is also good idea to keep the name short - you'll be referencing it a lot!
2020

2121
### Linux and OS X
2222

23-
Creating `virtualenv` in both Linux and OS X is as simple as typing in console (remember, that we expect that you have python 3.4 installed):
23+
Creating a `virtualenv` on both Linux and OS X is as simple as running:
2424

2525
~$ python3 -m venv blog
2626

27-
### Working with virtualenv
27+
## Working with virtualenv
2828

29-
The command above will create a folder `blog` that contains our virtual environment (basically bunch of folders and files). All we want to do now is starting it by:
29+
The command above will create a folder called `blog` that contains our virtual environment (basically bunch of folders and files). All we want to do now is starting it by running:
3030

3131
C:\Users\Name> blog\Scripts\activate
3232

33-
for Windows users, or:
33+
on Windows, or:
3434

3535
~$ source blog/bin/activate
3636

37-
for OS X and Linux.
37+
on OS X and Linux.
3838

3939
You will know that you have `virtualenv` started when you see that the prompt in your console looks like:
4040

@@ -44,36 +44,57 @@ or:
4444

4545
(blog) ~$
4646

47-
so the prefix `(blog)` appears!
47+
Notice the prefix `(blog)` appears!
4848

4949
When working within a virtual environment, `python` will automatically refer to the correct version so you can use `python` instead of `python3`.
5050

51-
Ok, we have all important things in place. We can finally install Django!
51+
OK, we have all important dependencies in place. We can finally install Django!
5252

5353
## Installing Django
5454

55-
Now, when you have your `virtualenv` started, you can install Django using PIP. In console you type `pip install django==1.6.5`.
55+
Now that you have your `virtualenv` started, you can install Django using `pip`. In the console, run `pip install django==1.6.5`.
5656

5757
(blog) ~$ pip install django==1.6.5
5858
Downloading/unpacking django==1.6.5
5959
Installing collected packages: django
6060
Successfully installed django
6161
Cleaning up...
6262

63-
### Installing PostgreSQL package for Python
63+
## Installing PostgreSQL package for Python
64+
65+
Next up, we need to install a package which lets Python talk to PostgreSQL - this is called `psycopg2`. The installation instructions differ slightly between Windows and Linux/OS X.
66+
67+
### Windows
68+
69+
The installation steps vary slightly depending on whether your computer runs 32 or 64 bit Windows. If you're not sure which you're running, ask your coach.
70+
71+
#### 32-bit
72+
73+
Run the following in your console:
74+
75+
(blog) C:\Users\Name> pip install git+https://github.com/nwcell/psycopg2-windows.git@win32-py34#egg=psycopg2
76+
77+
#### 64-bit
78+
79+
Run the following in your console:
80+
81+
(blog) C:\Users\Name> pip install git+https://github.com/nwcell/psycopg2-windows.git@win64-py34#egg=psycopg2
82+
83+
### Linux and OS X
84+
85+
Run the following in your console:
6486

6587
(blog) ~$ pip install psycopg2
88+
89+
---
90+
91+
If that goes well, you'll see something like this
92+
6693
Downloading/unpacking psycopg2
6794
Installing collected packages: psycopg2
6895
Successfully installed psycopg2
6996
Cleaning up...
7097

71-
On Windows, you will probably have to replace the first line with
72-
`pip install git+https://github.com/nwcell/psycopg2-windows.git@win32-py34#egg=psycopg2`
73-
or
74-
`pip install git+https://github.com/nwcell/psycopg2-windows.git@win64-py34#egg=psycopg2`
75-
depending on whether you have 32 or 64 bit Windows.
76-
77-
Once it's completed execute `python -c "import psycopg2"`. If you get no errors, everything works.
98+
Once that's completed, run `python -c "import psycopg2"`. If you get no errors, everything's installed successfully.
7899

79-
That's it! Now you are finally ready to create a Django application! But to do that, you need some nice program to edit the code...
100+
That's it! You're now (finally) ready to create a Django application! But to do that, you need a nice program to write your code in...

0 commit comments

Comments
 (0)