Skip to content

Commit 9e50766

Browse files
tbranyenJohn Haley
tbranyen
authored and
John Haley
committed
Latest guides work
1 parent b7fe3b1 commit 9e50766

File tree

14 files changed

+130
-46
lines changed

14 files changed

+130
-46
lines changed

‎guides/README.md‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,17 @@ description: Learning NodeGit
99

1010
> How to install NodeGit
1111
12-
- [To run guides](install/guides/)
13-
- [Windows users](install/windows-users/)
12+
- [Basics](install/basics/)
13+
- [From source](install/from-source)
1414
- [Atom Shell](install/atom-shell/)
15-
- [NW.js](install/nw-js/)
15+
- [NW.js](install/nw.js/)
1616

1717
## [Repository](repositories/)
1818

1919
> How to work with repositories
2020
2121
- [Initializing](repositories/initializing)
2222
- [Opening](repositories/opening)
23-
- [Freeing](repositories/freeing)
2423

2524
## [Cloning](cloning/)
2625

@@ -29,14 +28,3 @@ description: Learning NodeGit
2928
- [HTTP/HTTPS](cloning/http/)
3029
- [SSH w/ Agent](cloning/ssh-with-agent/)
3130
- [GitHub Two Factor Auth](cloning/gh-two-factor/)
32-
33-
## [Commits](commits/)
34-
35-
> How to work with commits
36-
37-
- [Push commits]()
38-
- [Diff commits]()
39-
40-
## [Merging](merging/)
41-
42-
> How to merge commits

‎guides/cloning/gh-two-factor/README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: GitHub Two Factor Auth Guide
55
description: How to clone with GitHub Two Factor Authorization
66
---
77

8-
**In order to run examples, you will need to [Install NodeGit](../../install)
8+
**In order to run examples, you will need to [Install NodeGit](../../install/basics)
99
first.**
1010

1111
[Return to cloning guides](../)
@@ -59,8 +59,7 @@ GitHub repository they will immediately revoke it.
5959
The first argument to the `clone` method is a URL.
6060

6161
In this example we're going to clone one of our private test repositories from
62-
GitHub. You could easily substitute this with any valid http or https Git
63-
repository URL.
62+
GitHub. This must be an `https` protocol URL for the clone to work.
6463

6564
``` javascript
6665
var cloneURL = "https://github.com/nodegit/private";

‎guides/cloning/http/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: HTTP/HTTPS Guide
55
description: How to clone with HTTP/HTTPS
66
---
77

8-
**In order to run examples, you will need to [Install NodeGit](../../install)
8+
**In order to run examples, you will need to [Install NodeGit](../../install/basics)
99
first.**
1010

1111
[Return to cloning guides](../)

‎guides/cloning/ssh-with-agent/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: SSH w/ Agent Guide
55
description: How to clone with SSH using an agent
66
---
77

8-
**In order to run examples, you will need to [Install NodeGit](../../install)
8+
**In order to run examples, you will need to [Install NodeGit](../../install/basics)
99
first.**
1010

1111
[Return to cloning guides](../)

‎guides/install/README.md‎

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,26 @@
11
---
22
layout: full
33
menu_item: guides
4-
title: Install Guide
4+
title: Install Guides
55
description: How to install NodeGit
66
---
77

88
[Return to all guides](../)
99

1010
* * *
1111

12-
From NPM
13-
--------
12+
### [Basics](basics/)
1413

15-
To install from NPM you can issue the following command:
14+
Learn how to install NodeGit
1615

17-
``` bash
18-
npm install nodegit
19-
```
16+
### [From source](from-source/)
2017

21-
From GitHub
22-
-----------
18+
Learn how to build NodeGit from source
2319

24-
This is required to contribute or run the examples.
20+
### [Atom Shell](atom-shell/)
2521

26-
Start by cloning the repository, chances are you will only need the latest
27-
commit, so you can pass the `--depth` flag to make a shallow clone:
22+
Learn how to use NodeGit with Atom Shell
2823

29-
``` bash
30-
git clone --depth=1 https://github.com/nodegit/nodegit
31-
```
24+
### [Nw.js](nw.js/)
3225

33-
Change your directory into the newly created nodegit folder.
34-
35-
``` bash
36-
cd nodegit
37-
```
38-
39-
Now you can issue the local installation command:
40-
41-
``` bash
42-
npm install
43-
```
26+
Learn how to use NodeGit with NW.js

‎guides/install/atom-shell/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: full
3+
menu_item: guides
4+
title: Atom Shell
5+
description: How to install NodeGit with Atom Shell
6+
---
7+
8+
[Return to install guides](../)
9+
10+
* * *

‎guides/install/basics/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: full
3+
menu_item: guides
4+
title: Basics
5+
description: How to install NodeGit
6+
---
7+
8+
[Return to install guides](../)
9+
10+
* * *
11+
12+
<a name="with-npm"></a>From NPM
13+
-------------------------------
14+
15+
To install from the NPM repository you can issue the following command:
16+
17+
``` bash
18+
npm install nodegit
19+
```
20+
21+
<a name="from-github"></a>From GitHub
22+
-------------------------------------
23+
24+
This is required to contribute or run the examples.
25+
26+
Start by cloning the repository, chances are you will only need the latest
27+
commit, so you can pass the `--depth` flag to make a shallow clone:
28+
29+
``` bash
30+
git clone --depth=1 https://github.com/nodegit/nodegit
31+
```
32+
33+
Change your directory into the newly created nodegit folder.
34+
35+
``` bash
36+
cd nodegit
37+
```
38+
39+
Now you can issue the local installation command:
40+
41+
``` bash
42+
npm install
43+
```

‎guides/install/from-source/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: full
3+
menu_item: guides
4+
title: From source
5+
description: How to build NodeGit from source
6+
---
7+
8+
[Return to install guides](../)
9+
10+
* * *

‎guides/install/nw.js/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: full
3+
menu_item: guides
4+
title: NW.js
5+
description: How to install NodeGit with NW.js
6+
---
7+
8+
[Return to install guides](../)
9+
10+
* * *

‎guides/repositories/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: full
3+
menu_item: guides
4+
title: Repository Guides
5+
description: How to work with repositories
6+
---
7+
8+
[Return to all guides](../)
9+
10+
* * *
11+
12+
### [Initializing](initializing/)
13+
14+
> Emulates `git init`
15+
16+
How to initialize a new repository
17+
18+
### [Opening](opening/)
19+
20+
How to open and free a repository

0 commit comments

Comments
 (0)