Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

Update Getting Started (How to change the project and why?) #7708

Merged
merged 2 commits into from
Jul 9, 2014
Merged

Update Getting Started (How to change the project and why?) #7708

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e9cf8c
Update Getting Started (How to change the project, why?)
Apr 30, 2014
0fa50d0
Wordsmithing (@njx)
Jul 9, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions samples/root/Getting Started/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
Expand All @@ -9,7 +9,7 @@
<link rel="stylesheet" href="main.css">
</head>
<body>

<h1>GETTING STARTED WITH BRACKETS</h1>
<h2>This is your guide!</h2>

Expand Down Expand Up @@ -106,14 +106,14 @@ <h3>Live Highlight HTML elements and CSS rules</h3>
color from "transparent" to "hotpink". If you have Brackets and your browser running side-by-side, you
will see your changes instantly reflected in your browser. Cool, right?
</samp>

<p class="note">
Today, Brackets only supports Live Preview for HTML and CSS. However, in the current version, changes to
JavaScript files are automatically reloaded when you save. We are currently working on Live Preview
support for JavaScript. Live previews are also only possible with Google Chrome, but we hope
to bring this functionality to all major browsers in the future.
</p>

<h3>Quick View</h3>
<p>
For those of us who haven't yet memorized the color equivalents for HEX or RGB values, Brackets makes
Expand Down Expand Up @@ -141,15 +141,30 @@ <h3>Need something else? Try an extension!</h3>
the "Install" button next to it.
</p>

<h3>Projects in Brackets</h3>
<p>
In order to edit your own code using Brackets, you can just open the folder containing your files.
Brackets treats the currently open folder as a "project"; features like Code Hints, Live Preview and
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@njx I guess it should be Code Hints instead of code hints (that's what you wrote), right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was originally thinking that "code hints" isn't a specific feature name (as opposed to Live Preview and Quick Edit), but that might just be a distinction in my head. In any case, it probably looks better to capitalize it as you did.

Quick Edit only use files within the currently open folder.
</p>

<samp>
Once you're ready to get out of this sample project and edit your own code, you can use the dropdown
in the left sidebar to switch folders. Right now, the dropdown says "Getting Started" - that's the
folder containing the file you're looking at right now. Click on the dropdown and choose "Open Folder…"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the ellipses turned into a single character. I wonder if we should use an entity for that, or just three separate periods.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't use an entity - it's text to be read by a human (it won't be shown in the browser because of the <samp> tags).
It don't care whether it's periods or a single character, I took it because the actual Open Folder… button uses these ellipsis, too.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, seems like it's fine.

to open your own folder.
You can also use the dropdown later to switch back to folders you've opened previously, including this
sample project.
</samp>

<!--
LET US KNOW WHAT YOU THINK
-->
<h2>Get involved</h2>
<p>
Brackets is an open-source project. Web developers from around the world are contributing to build
a better code editor. Many more are building extensions that expand the capabilities of Brackets.
Let us know what you think, share your ideas or contribute directly to the
project.
Let us know what you think, share your ideas or contribute directly to the project.
</p>
<ul>
<li><a href="http://brackets.io">Brackets.io</a></li>
Expand All @@ -161,7 +176,7 @@ <h2>Get involved</h2>
<li><a href="https://twitter.com/#!/brackets">@brackets on Twitter</a></li>
<li>Chat with Brackets developers on IRC in #brackets on Freenode</li>
</ul>

</body>
</html>
<!--
Expand Down