Skip to content

Commit 0dcbb0f

Browse files
author
maxwell
committed
second pass on readme, added clarification, tested commands
1 parent 46f3b19 commit 0dcbb0f

File tree

5 files changed

+110
-32
lines changed

5 files changed

+110
-32
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.DS_Store

.learn

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
tags:
2-
- none
2+
- bundler
3+
- introduction
34
languages:
4-
- none
5-
resources:
6-
- none
5+
- ruby
6+
resources: 2

CONTRIBUTING.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Contributing to Learn.co Curriculum
22

3-
We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
3+
We're really exited that you're about to contribute to the [open
4+
curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co).
5+
If this is your first time contributing, please continue reading to learn how
6+
to make the most meaningful and useful impact possible.
47

58
## Raising an Issue to Encourage a Contribution
69

LICENSE.md

+19-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
1-
#Learn.co Educational Content License
1+
# Learn.co Educational Content License
22

33
Copyright (c) 2015 Flatiron School, Inc
44

5-
The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth here (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
6-
7-
Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth here (http://learn.co/content-license). By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License. If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.
5+
The Flatiron School, Inc. owns this Educational Content. However, the Flatiron
6+
School supports the development and availability of educational materials in
7+
the public domain. Therefore, the Flatiron School grants Users of the Flatiron
8+
Educational Content set forth in this repository certain rights to reuse, build
9+
upon and share such Educational Content subject to the terms of the Educational
10+
Content License set forth [here](http://learn.co/content-license)
11+
(http://learn.co/content-license). You must read carefully the terms and
12+
conditions contained in the Educational Content License as such terms govern
13+
access to and use of the Educational Content.
814

15+
Flatiron School is willing to allow you access to and use of the Educational
16+
Content only on the condition that you accept all of the terms and conditions
17+
contained in the Educational Content License set forth
18+
[here](http://learn.co/content-license) (http://learn.co/content-license). By
19+
accessing and/or using the Educational Content, you are agreeing to all of the
20+
terms and conditions contained in the Educational Content License. If you do
21+
not agree to any or all of the terms of the Educational Content License, you
22+
are prohibited from accessing, reviewing or using in any way the Educational
23+
Content.

README.md

+82-23
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,35 @@
55
If you've completed the steps in the Setting Up a New Site lesson, clone down
66
your existing exceptional-realty repository by do the following:
77

8-
* Open the Learn IDE, and in the terminal, type `git clone https://github.com/<your_username_here>/exceptional-realty`
9-
* A folder with your previous work will appear in the IDE file tree.
8+
* Open the Learn IDE, and in the terminal, type
9+
10+
```
11+
git clone https://github.com/<your_username_here>/exceptional-realty
12+
cd exceptional-realty
13+
git fetch --all
14+
git checkout main-pages
15+
```
16+
17+
* A folder with your previous work will appear in the IDE file tree, all
18+
remote branches will be retrieved, and you will then switch to the
19+
`main-pages` branch we started in the previous lesson.
1020

1121
Alternatively, if you are having trouble or do not have a repository
12-
set up, you can access all the files you need to follow along by following the following steps to clone down the demo:
22+
set up, you can access all the files you need to follow along by following
23+
the following steps to clone down the demo:
1324

1425
* In your terminal, type `git clone https://github.com/learn-co-curriculum/exceptional-realty-demo`.
15-
* Once the repository is cloned down, type `cd exceptional-realy-demo` to navigate into the repository folder.
16-
* In the project folder, type `git fetch document-structure`. This will copy the branch `document-structure` to your local environment.
17-
* To switch to this branch, type `git checkout document-structure`, and you should see files appear in your directory tree.
26+
* Once the repository is cloned down, type `cd exceptional-realy-demo` to
27+
navigate into the repository folder.
28+
* In the project folder, type `git fetch --all`, then type
29+
`git checkout document-structure` to switch over to the branch for this
30+
repository, and you should see files appear in your directory tree.
1831

19-
These files mirror the files that exist at the start of this lesson, so use these to build from and follow along.
32+
These files mirror the files that exist at the start of this lesson, so use
33+
these to build from and follow along.
2034

21-
**Note:** To see your project live as you code, simply type `httpserver` in the terminal, and this will start a server for you. Now you can go to the IP address that the terminal gives you to view your web pages! (Check out [this Help Center article](http://help.learn.co/the-learn-ide/common-ide-questions/viewing-html-pages-in-the-learn-ide) for more information).
35+
**Note:** To see your project live as you code, simply type `httpserver` in the terminal, and this will start a server for you. Now you can go to the IP
36+
address that the terminal gives you to view your web pages! (Check out [this Help Center article](http://help.learn.co/the-learn-ide/common-ide-questions/viewing-html-pages-in-the-learn-ide) for more information).
2237

2338
<iframe width="640" height="480" src="//www.youtube.com/embed/RBQX-Ko7A_s?rel=0&modestbranding=1" frameborder="0" allowfullscreen></iframe>
2439

@@ -30,13 +45,23 @@ These files mirror the files that exist at the start of this lesson, so use thes
3045

3146
#### `<!DOCTYPE html>`
3247

33-
At the top of every HTML document, you're always going to start off with the same element, `doctype`. The `doctype` element starts with a `<`, followed by an `!` and `doctype`, then specifies which version of HTML we want to use. In HTML5, we just say `html`, and the browser will interpret the rest of the document as HTML5. Go ahead and add `<!DOCTYPE html>` to your `index.html` file.
48+
At the top of every HTML document, you're always going to start off with the
49+
same element, `DOCTYPE`. The `DOCTYPE` element starts with a `<`, followed by
50+
an `!` and `DOCTYPE`, then specifies which version of HTML we want to use. In
51+
HTML5, we just say `html`, and the browser will interpret the rest of the
52+
document as HTML5. To close the element, add a `>` at the end. Go ahead and
53+
add `<!DOCTYPE html>` to your `index.html` file.
3454

3555
#### `<html> </html>`
3656

37-
The next element is also always required: `<html>`. This tells the browser that everything that falls between the opening and closing `html` tags is to be interpreted as HTML code.
57+
The next element is also always required: `<html>`. This tells the browser
58+
that everything that falls between the opening and closing `html` tags is to
59+
be interpreted as HTML code.
3860

39-
One attribute that is important to include in the `<html>` tag is `lang`, which declares what language the webpage is written in. In our case, writing in English, we will use `lang="en"`. This helps search engines to know what language a page is in. Our `index.html` should now look like this:
61+
One attribute that is important to include in the `<html>` tag is `lang`, which
62+
declares what language the webpage is written in. In our case, writing in
63+
English, we will use `lang="en"`. This helps search engines to know what
64+
language a page is written in. Our `index.html` should now look like this:
4065

4166
```
4267
<!DOCTYPE html>
@@ -46,45 +71,79 @@ One attribute that is important to include in the `<html>` tag is `lang`, which
4671

4772
#### `<!-- Comments -->`
4873

49-
Inside our HTML, sometimes we want to leave notes either for ourselves or for other developers. An example might be a brief explanation of what some part of the code is doing, or an important message or reminder. We can write comments by wrapping the text we want like so:
74+
Inside our HTML, sometimes we want to leave notes either for ourselves or for
75+
other developers. An example might be a brief explanation of what some part of
76+
the code is doing, or an important message or reminder. We can write comments
77+
by wrapping the text we want like so:
5078

5179
```
5280
<!-- This is a comment! -->
5381
```
5482

55-
Text included in a comment will not be visible on the webpage, but will be visible in the browser console and `.html` file.
83+
Text included in a comment will not be visible on the webpage, but will be
84+
visible in the browser console and `.html` file.
5685

5786
#### `<head> </head>`
5887

59-
Inside our `<html>` tags, we divide the page into two main sections, `<head>`, and `<body>`, which both play unique roles. Before we get to adding viewable content, there are some additional bits of information we need to declare about our webpage, and this information will be stored in the `<head>`.
88+
Inside our `<html>` tags, we divide the page into two main sections, `<head>`,
89+
and `<body>`, which both play unique roles. Before we get to adding viewable
90+
content, there are some additional bits of information we need to declare about
91+
our webpage, and this information will be stored in the `<head>`.
6092

6193
In the `<head>` section, we place a number of specific tags.
6294

63-
* The `<meta>` tag provides metadata about the document, including what character set to us, a description of the content, specific keywords, and the author. Adding this metadata on the content of the page helps search engines to know what the page contains. There is also a `viewport` method, which instructs the browser on how to control the page's dimensions and scaling. Examples of `<meta>` tags:
95+
* The `<meta>` tag provides metadata about the document, including what
96+
character set to us, a description of the content, specific keywords, and the
97+
author. Adding this metadata on the content of the page helps search engines
98+
to know what the page contains. There is also a `viewport` method, which
99+
instructs the browser on how to control the page's dimensions and scaling.
100+
Examples of `<meta>` tags we can add into our `head` section:
64101

65102
```
66103
<meta charset="UTF-8">
67-
<meta name="description" content="Exceptional Realty, your real estate agent for buying, selling, and renting in all of Rhode Island">
68-
<meta name="keywords" content="Exceptional Realty, real estate, houses, property">
104+
<meta name="description" content="Exceptional Realty Group, your real estate agent for buying, selling, and renting throughout New York City">
105+
<meta name="keywords" content="Exceptional Realty Group, real estate, houses, property">
69106
<meta name="author" content="Jon Grover">
70107
<meta name="viewport" content="width=device-width, initial-scale=1.0">
71108
```
72109

73-
* The `<link>` tag is also used here, and is for importing in external files. Most commonly, we'll see this being used to import in CSS style sheets, fonts, and JavaScript files and libraries.
74-
* Another common tag in the `<head>` is `<title>`. The `<title>`, as its name implies, is where the title of the webpage should be entered. Text added inside the `<title>` tags will appear up on your browser tab.
110+
* The `<link>` tag is also used here, and is for importing in external files.
111+
Most commonly, we'll see this being used to import in CSS style sheets, fonts,
112+
and JavaScript files and libraries. In the below example, `link` is used to
113+
import in a specific Google font:
114+
115+
```
116+
<link href="https://fonts.googleapis.com/css?family=Monoton" rel="stylesheet">
117+
```
118+
119+
* Another common tag in the `<head>` is `<title>`. The `<title>`, as its name
120+
implies, is where the title of the webpage should be entered. Text added inside
121+
the `<title>` tags will appear up on your browser tab. Let's add a title for
122+
our `index.html` page:
123+
124+
```
125+
<title>Exceptional Realty Group - Luxury Homes - About</title>
126+
```
75127

76-
### `<body> </body>`
128+
If you spin up `httpserver` and check out the site, it'll still be blank, but
129+
notice that the tab has our title in it!
77130

78-
All viewable content of a webpage is contained within the `<body>` section of the page. In the next lesson, we'll go into some of the basic text elements that go into the `<body>`.
131+
In the next lesson, we'll go into some of the basic text elements that go into
132+
the `<body>` section!
79133

80134
### Add, Commit and Push!
81135

82-
If you're following along on your own repository, when you're finished, make sure that your work is saved remotely before moving on to the next lesson!
136+
If you're following along on your own repository, when you're finished, make
137+
sure that your work is saved remotely before moving on to the next lesson!
83138

84139
```
85140
git add .
86-
git commit -m 'document structure lesson complete'
141+
git commit -m 'added document structure and head content to index.html'
87142
git push
88143
```
89144

145+
Notice, too, that since you've already set up tracking on your branch from the
146+
previous lesson, you can now just use `git push` and the `main-pages` branch
147+
will be updated remotely.
148+
90149
<p class='util--hide'>View <a href='https://learn.co/lessons/document-structure'>Document Structure</a> on Learn.co and start learning to code for free.</p>

0 commit comments

Comments
 (0)