forked from desktop/dugite
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
3 changed files
with
20 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |