Cynarski/kickstart
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Bruno Lara Tavares 2014-03-07 00:44:02 -03:00
parent 1b15df2ce9
commit 4420a365f5
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -14,7 +14,8 @@ For an example project, check [kickstart-baseline](https://github.com/bltavares/
### Documentation ### Documentation
Kickstart provides offline documentation using the `kickstart doc` command as well as an online on http://bltavares.viewdocs.io/kickstart Kickstart provides offline documentation using the `kickstart doc` command as well as an online on http://bltavares.viewdocs.io/kickstart.
Autocompletion is enabled for the offline documentation. Autocompletion is enabled for the offline documentation.
### Installation ### Installation
@ -36,6 +37,7 @@ echo 'export PATH=$PATH:'$installation_path'/bin' >> $shell_configuration
#### Link under /usr/local/bin #### Link under /usr/local/bin
The other is to link the `bin/kickstart` into a place that is already on your path. The other is to link the `bin/kickstart` into a place that is already on your path.
This will allow `sudo` to see the `kickstart` command. This will allow `sudo` to see the `kickstart` command.
```bash ```bash
# Adjust the paths to your preferred location # Adjust the paths to your preferred location
@ -189,6 +191,7 @@ DEBUG=1 kickstart local nodejs
### Choosing the docker image to use ### Choosing the docker image to use
You can choose an specific image to use on the docker-* commands. You can choose an specific image to use on the docker-* commands.
On order, it looks up for an image as an argument, on the `KICKSTART_DOCKER_IMAGE` env variable or defaults to moul/sshd. On order, it looks up for an image as an argument, on the `KICKSTART_DOCKER_IMAGE` env variable or defaults to moul/sshd.
You can use any image that is on the index, you probably want it to have an sshd running by default. You can use any image that is on the index, you probably want it to have an sshd running by default.