Commit 9e507663 authored by Tim Branyen's avatar Tim Branyen Committed by John Haley

Latest guides work

parent b7fe3b1b
......@@ -9,10 +9,10 @@ description: Learning NodeGit
> How to install NodeGit
- [To run guides](install/guides/)
- [Windows users](install/windows-users/)
- [Basics](install/basics/)
- [From source](install/from-source)
- [Atom Shell](install/atom-shell/)
- [NW.js](install/nw-js/)
- [NW.js](install/nw.js/)
## [Repository](repositories/)
......@@ -20,7 +20,6 @@ description: Learning NodeGit
- [Initializing](repositories/initializing)
- [Opening](repositories/opening)
- [Freeing](repositories/freeing)
## [Cloning](cloning/)
......@@ -29,14 +28,3 @@ description: Learning NodeGit
- [HTTP/HTTPS](cloning/http/)
- [SSH w/ Agent](cloning/ssh-with-agent/)
- [GitHub Two Factor Auth](cloning/gh-two-factor/)
## [Commits](commits/)
> How to work with commits
- [Push commits]()
- [Diff commits]()
## [Merging](merging/)
> How to merge commits
......@@ -5,7 +5,7 @@ title: GitHub Two Factor Auth Guide
description: How to clone with GitHub Two Factor Authorization
---
**In order to run examples, you will need to [Install NodeGit](../../install)
**In order to run examples, you will need to [Install NodeGit](../../install/basics)
first.**
[Return to cloning guides](../)
......@@ -59,8 +59,7 @@ GitHub repository they will immediately revoke it.
The first argument to the `clone` method is a URL.
In this example we're going to clone one of our private test repositories from
GitHub. You could easily substitute this with any valid http or https Git
repository URL.
GitHub. This must be an `https` protocol URL for the clone to work.
``` javascript
var cloneURL = "https://github.com/nodegit/private";
......
......@@ -5,7 +5,7 @@ title: HTTP/HTTPS Guide
description: How to clone with HTTP/HTTPS
---
**In order to run examples, you will need to [Install NodeGit](../../install)
**In order to run examples, you will need to [Install NodeGit](../../install/basics)
first.**
[Return to cloning guides](../)
......
......@@ -5,7 +5,7 @@ title: SSH w/ Agent Guide
description: How to clone with SSH using an agent
---
**In order to run examples, you will need to [Install NodeGit](../../install)
**In order to run examples, you will need to [Install NodeGit](../../install/basics)
first.**
[Return to cloning guides](../)
......
---
layout: full
menu_item: guides
title: Install Guide
title: Install Guides
description: How to install NodeGit
---
......@@ -9,35 +9,18 @@ description: How to install NodeGit
* * *
From NPM
--------
### [Basics](basics/)
To install from NPM you can issue the following command:
Learn how to install NodeGit
``` bash
npm install nodegit
```
### [From source](from-source/)
From GitHub
-----------
Learn how to build NodeGit from source
This is required to contribute or run the examples.
### [Atom Shell](atom-shell/)
Start by cloning the repository, chances are you will only need the latest
commit, so you can pass the `--depth` flag to make a shallow clone:
Learn how to use NodeGit with Atom Shell
``` bash
git clone --depth=1 https://github.com/nodegit/nodegit
```
### [Nw.js](nw.js/)
Change your directory into the newly created nodegit folder.
``` bash
cd nodegit
```
Now you can issue the local installation command:
``` bash
npm install
```
Learn how to use NodeGit with NW.js
---
layout: full
menu_item: guides
title: Atom Shell
description: How to install NodeGit with Atom Shell
---
[Return to install guides](../)
* * *
---
layout: full
menu_item: guides
title: Basics
description: How to install NodeGit
---
[Return to install guides](../)
* * *
<a name="with-npm"></a>From NPM
-------------------------------
To install from the NPM repository you can issue the following command:
``` bash
npm install nodegit
```
<a name="from-github"></a>From GitHub
-------------------------------------
This is required to contribute or run the examples.
Start by cloning the repository, chances are you will only need the latest
commit, so you can pass the `--depth` flag to make a shallow clone:
``` bash
git clone --depth=1 https://github.com/nodegit/nodegit
```
Change your directory into the newly created nodegit folder.
``` bash
cd nodegit
```
Now you can issue the local installation command:
``` bash
npm install
```
---
layout: full
menu_item: guides
title: From source
description: How to build NodeGit from source
---
[Return to install guides](../)
* * *
---
layout: full
menu_item: guides
title: NW.js
description: How to install NodeGit with NW.js
---
[Return to install guides](../)
* * *
---
layout: full
menu_item: guides
title: Repository Guides
description: How to work with repositories
---
[Return to all guides](../)
* * *
### [Initializing](initializing/)
> Emulates `git init`
How to initialize a new repository
### [Opening](opening/)
How to open and free a repository
---
layout: full
menu_item: guides
title: Initializing
description: How to initialize a repository
---
[Return to repository guides](../)
* * *
---
layout: full
menu_item: guides
title: Opening
description: How to open and free a repository
---
[Return to repository guides](../)
* * *
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment