Skip to content

Commit e538501

Browse files
committed
readme updates for docker, contributing section
1 parent 7300413 commit e538501

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,21 @@ $ toodles
108108
```
109109
#### Running with Docker
110110

111+
You can run a pre-built toodles for your current directory via docker:
112+
113+
```bash
114+
# execute toodles for the directory you are currently in:
115+
$ docker run -it -v $(pwd):/repo -p 9001:9001 aviaviavi/toodles
116+
```
117+
118+
Just mount your project into the container's `/repo` and direct a port of your choice to the container's `9001`.
119+
111120
For convenience this repository also provides a `Dockerfile` to automatically
112121
build toodles.
113122

114123
```bash
115124
# to build container run:
125+
$ cd /path/to/toodles/repo
116126
$ docker build -t toodles .
117127
# afterwards you can run the following command to execute toodles for the
118128
# directory you are currently in:
@@ -135,3 +145,17 @@ initiated comment. For instance in javascript
135145
*/
136146
```
137147

148+
### Contributing
149+
150+
Contributions in any form are welcome! A few bits of info:
151+
152+
- Don't be shy, ask questions! Contributing to Toodles should be welcoming for
153+
people at any level of programming familiarity. Whether it's a new feature,
154+
bug fix, or docs, any contribution is very appreciated.
155+
- Before you start coding, please comment or mark a particular issue as "in
156+
progress", or even open your pull request as a work in progress (WIP). This is
157+
to help avoid having multiple people work on the same thing.
158+
- If github issues don't cut it, feel free to reach out on twitter
159+
[@avi_press](https://twitter.com/avi_press)
160+
161+

0 commit comments

Comments
 (0)