Skip to content

Commit 7d4444d

Browse files
author
Jeremy Tammik
committed
edited for clarify
1 parent a97cf38 commit 7d4444d

File tree

1 file changed

+38
-24
lines changed

1 file changed

+38
-24
lines changed

prerequisites.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,36 @@
55
- [Install Node.js](#InstallNodeJs)
66
- [Install a code editor](#InstallCodeEditor)
77
- [Get the sources](#GetTheSources)
8-
8+
99

1010
<a name="FamiliarWithGit"></a>
1111
## Familiar with git?
1212

13-
Note that, if you do not have git installed already, you can get it from here: [Windows](https://windows.github.com/), [Mac OSX](https://mac.github.com/), and [Linux](http://git-scm.com/download/linux).
14-
And get additional setup instructions [here](https://help.github.com/articles/set-up-git).
13+
[Git](http://www.git-scm.com) is a free and open source distributed version control system.
14+
It enables teams to work together efficiently, all using the same files.
15+
16+
It also helps teams cope with the confusion that can happen when multiple people are editing the same files.
17+
18+
This tutorial is hosted on GitHub, a Git repository hosting service, that also adds many of its own additional features.
19+
20+
While Git is a command line tool, GitHub provides a Web-based graphical interface and a GUI tools.
21+
22+
It also provides access control and several collaboration features, such as a Wiki and basic task management tools for every project.
23+
24+
If you do not have git installed already, you can get it from here:
25+
26+
- [Windows](https://windows.github.com)
27+
- [Mac OSX](https://mac.github.com)
28+
- [Linux](http://git-scm.com/download/linux)
1529

16-
Git allows a team of people to work together, all using the same files. And it helps the team cope with the confusion that tends to happen when multiple people are editing the same files.
17-
GitHub is a Git repository hosting service, but it adds many of its own features. While Git is a command line tool, GitHub provides a Web-based graphical interface and a GUI tools. It also
18-
provides access control and several collaboration features, such as a wikis and basic task management tools for every project..
30+
Here are some [additional setup instructions](https://help.github.com/articles/set-up-git), and many other questions are covered by the [GitHub Help](https://help.github.com).
1931

2032
Here is a [github quick learning tutorial](https://try.github.io/levels/1/challenges/1) if you never used git before. Note it is a command line tutorial, but you may prefer the GUI or WEB interfaces.
2133

22-
If you have a GitHub client ([GitHub for Windows](https://windows.github.com/) or [GitHub for Mac](https://mac.github.com/)) installed, you can clone
23-
a repository from GitHub. Go to the the repository you want to download locally and clone the source code by clicking the 'Clone in Desktop' button.
34+
Once you have a GitHub client installed, you can clone
35+
a repository from GitHub.
36+
37+
Go to the the repository you want to download locally and clone the source code by clicking the 'Clone in Desktop' button.
2438

2539
![](img/githubClone.png)
2640

@@ -33,15 +47,15 @@ Your repository git url can be obtain from the 'HTTPs clone URL' box.
3347

3448
![](img/githubCloneURL.png)
3549

36-
This creates the a copy of all the source of the repository on your local drive. In this 'clone' directory, you can find the files from the repository which you can work with.
37-
However, it is important to note here that unless you got write permission, you would not be able to save your changes in the repo. To be able to save in the repo you clone,
38-
you either need to be a contributor on that repo, or have cloned one of your own repo. If you want to work from someone else repo, and be able to edit and save your changes,
50+
This creates the a copy of all the source of the repository on your local drive. In this 'clone' directory, you can find the files from the repository which you can work with.
51+
However, it is important to note here that unless you got write permission, you would not be able to save your changes in the repo. To be able to save in the repo you clone,
52+
you either need to be a contributor on that repo, or have cloned one of your own repo. If you want to work from someone else repo, and be able to edit and save your changes,
3953
please consider to 'fork' the repo in your account, and clone that repo instead from your account. See below instructions [how to fork a repo](#Fork).
4054

4155
If you prefer not to install git, you can download a zip file instead by clicking the 'Download ZIP' button.
4256

4357
![](img/githubDownload.png)
44-
58+
4559
In this workshop, we will provide the command line instructions, but feel free to use the method you prefer.
4660

4761

@@ -82,8 +96,8 @@ Either checkout a tag version or a branch. Updates files in the working tree to
8296
### git command line
8397

8498
Using git from the command line on Mac OSX or Linux is straight forward, just open a terminal window (on Mac OSx - Applications -> Utilities -> Terminal.app). git, node, and npm commands should work from there if present on your system.
85-
On Windows, you can choose between few options: a bash console, a powershell console, or the standard command prompt. You can decide which one to use from the Github tool in the settings panel.
86-
You would access the git console by running the 'Git Shell' icon which should be on your Desktop or in your Programs list. Node and npm commands have their own command prompt window which is
99+
On Windows, you can choose between few options: a bash console, a powershell console, or the standard command prompt. You can decide which one to use from the Github tool in the settings panel.
100+
You would access the git console by running the 'Git Shell' icon which should be on your Desktop or in your Programs list. Node and npm commands have their own command prompt window which is
87101
different from GitHub.
88102

89103

@@ -94,7 +108,7 @@ Last, someone may want to work on the wokshop and saves this results on his own
94108
To fork a repository, log in Github using your account, go to the repository you want to fork, and press the 'Fork' button.
95109

96110
![](img/githubFork.png)
97-
111+
98112

99113
<a name="InstallNodeJs"></a>
100114
## Install Node.js
@@ -119,7 +133,7 @@ If you need to run different versions of node.js in your local environment, cons
119133
<a name="InstallCodeEditor"></a>
120134
## Install a code editor
121135

122-
If you have programmed before, you may already have a favorite programmer's editor. However, if you do not, or were thinking about trying other editors anyway,
136+
If you have programmed before, you may already have a favorite programmer's editor. However, if you do not, or were thinking about trying other editors anyway,
123137
spend some time trying and considering these options common in the javascript/node.js community ...
124138

125139
Note, they are not listed in the order of preference.
@@ -133,13 +147,13 @@ Note, they are not listed in the order of preference.
133147
[textmate](http://macromates.com/) | - | X | - | Paid
134148
[Sublime Text](http://www.sublimetext.com/) | X | X | X | Paid
135149
[WebStorm](https://www.jetbrains.com/webstorm/) | X | X | X | Paid
136-
150+
137151

138152
<a name="GetTheSources"></a>
139153
## Get the sources
140154

141-
We assume you want to start a project and work as a team. For this reason, you want to use 'git' and be able to share the sources across the members of your team,
142-
and later deploy it on a web server. Your first action will be to fork the material repository on your 'github' account.
155+
We assume you want to start a project and work as a team. For this reason, you want to use 'git' and be able to share the sources across the members of your team,
156+
and later deploy it on a web server. Your first action will be to fork the material repository on your 'github' account.
143157
If you prefer not to use git, you can still download the zip files and inflate their contents on your local drive.
144158

145159
* Using git
@@ -150,10 +164,10 @@ If you prefer not to use git, you can still download the zip files and inflate t
150164
- In the git console, run the following commands:<br />
151165
```
152166
git clone <your HTTPS clone URL>
153-
167+
154168
git checkout v1.0-workshop
155169
```
156-
The first command creates the workflow-node.js-view.and.data.api in your current directory. The second command is optional and is there to make sure we work on
170+
The first command creates the workflow-node.js-view.and.data.api in your current directory. The second command is optional and is there to make sure we work on
157171
the correct version of the material made for this instructions.
158172
- Change your working directory <br />
159173
```
@@ -165,12 +179,12 @@ If you prefer not to use git, you can still download the zip files and inflate t
165179
- Download the ZIP file from [here](https://github.com/Developer-Autodesk/workflow-node.js-view.and.data.api/releases/tag/v1.0-workshop)
166180
- Inflate the ZIP file on your hard drive
167181
- Make the inflated directory your current directory
168-
182+
169183
170184
The tutorial instructions, from now on, assumes you are running all commands from the *workflow-node.js-view.and.data.api* directory.
171185
172-
186+
173187
174188
=========================
175-
[Next](chapter-1.md#Chapter1) -
189+
[Next](chapter-1.md#Chapter1) -
176190
[Home](README.md)

0 commit comments

Comments
 (0)