Create README.md (#209)

* Create README.md
This commit is contained in:
Brian Hendriks
2019-01-04 17:51:07 -08:00
committed by GitHub
parent 32040e15ab
commit c95032e176

32
README.md Normal file
View File

@@ -0,0 +1,32 @@
# Installing the dolt command line
## Prerequisites
* Clone this repo and pull the latest
* Install go: https://golang.org/doc/install
* Set the environment variable NOMS_VERSION_NEXT=1
* run: git config --global --add url."ssh://git@github.com".insteadOf "https://github.com"
* add the go binary installation directory to your Path variable
* ~/go/bin on OSX
* %USERPROFILE%/go/bin
## Installation
* Open a command line in the dolt/go directory
* run: go install github.com/liquidata-inc/ld/dolt/go/cmd/dolt
## First commands
* dolt config --global add user.email YOU@liquidata.co
* dolt config --global add user.name = YOUR NAME
## Setting up a repo
* make a new directory with nothing in it
* From the new directory run dolt init
## Docs
* The latest documentation will always be in the tool itself. run "dolt" to see a list of standard git like commands.
run "dolt table" to see the table subcommands. To get the help for any command use the --help flag after the name of the command.
* Initial version of the documentation looks like this: https://docs.google.com/document/d/169Zhh_r1hmxZo5V3N_aOx7i6ImJCVBbaB8EBXyH8p3o/edit#