Skip to content

Fixing the markdown of the README #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eduardogr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixing the markdown of the README #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
#Overview
# Overview
This project is a simple Docker image that runs the [Charles Proxy](http://www.charlesproxy.com/).

#Prerequisites
# Prerequisites
* a working [Docker](http://docker.io) engine
* a working [Docker Compose](http://docker.io) installation

#Building
# Building
Type `docker-compose build` to build the image.

#Installation
# Installation
Docker will automatically install the newly built image into the cache.

#Tips and Tricks
# Tips and Tricks

##Launching The Image
## Launching The Image

`docker-compose up` will launch the image allowing you to begin working on projects. The Docker Compose file is
configured to mount your home directory into the container.

#Troubleshooting
# Troubleshooting

##User Account
## User Account
The image assumes that the account running the continer will have a user and group id of 1000:1000. This allows the container
to save files in your home directory and keep the proper permissions.

##X-Windows
## X-Windows
If the image complains that it cannot connect to your X server, simply run `xhost +` to allow the container to connect
to your X server.

##Firefox Plug-In
## Firefox Plug-In
TODO

#License and Credits
# License and Credits
This project is licensed under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/).

#List of Changes
# List of Changes