Skip to content

Commit

Permalink
tweaking notes
Browse files Browse the repository at this point in the history
shiftkey committed Mar 21, 2017
1 parent d7639eb commit 491dd57
Showing 3 changed files with 20 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -2,6 +2,8 @@

This project provides bindings for Node applications to interact with Git repositories, using the same command line interface that core Git offers.

The bindings are written in Typescript.

### Getting Started

```
@@ -29,7 +31,8 @@ if (result.exitCode === 0) {

- make it easy to work with Git repositories
- use the same commands as you would in a shell
- package an up-to-date version of Git in your application
- access to the full set of commands, options and formatting that Git core uses
- access to the latest features of Git

### Supported Platforms

1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Documentation

- [Overview](./overview.md) - introduces how the repository and scripts work
- [Setup](./setup.md) - what you need to get involved with contributing to `dugite`
- [API](./api-extensibility.md) - the hooks provided by `dugite` to support advanced behaviour when executing commands
- [Parsing Errors](./parsing-errors.md) - how to use `dugite` to parse errors from Git
- [Releases](./releases.md) - details about how releases are made
15 changes: 15 additions & 0 deletions docs/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Setup

This is what you need to install:

- [NodeJS](https://nodejs.org) v6 or higher

Then open a shell and clone the repository to your local machine.

To ensure everything is working, run this command from the root of the repository:

```sh
npm install
```

This will install the depedencies, compile the library source and run the suite of tests.

0 comments on commit 491dd57

Please sign in to comment.