Create README.md
This commit is contained in:
committed by
GitHub Enterprise
parent
aabd89fae8
commit
ae24ca3a2a
89
README.md
Normal file
89
README.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Ansible for DS Financial demo network
|
||||
|
||||
Create and configure hosts (typically a Raspberry PI) for sites on demo network. Create and install tools to generate network traffic.
|
||||
|
||||
## Getting Started
|
||||
|
||||
TBD: On first PI:
|
||||
* connect to Comcast network to access Github Enterprise
|
||||
* install updates
|
||||
* set password for *pi* account
|
||||
* git clone this repo
|
||||
* edit hosts per example
|
||||
|
||||
### Prerequisites
|
||||
|
||||
What things you need to install the software and how to install them
|
||||
|
||||
```
|
||||
Give examples
|
||||
```
|
||||
|
||||
### Installing
|
||||
|
||||
A step by step series of examples that tell you how to get a development env running
|
||||
|
||||
Say what the step will be
|
||||
|
||||
```
|
||||
Give the example
|
||||
```
|
||||
|
||||
And repeat
|
||||
|
||||
```
|
||||
until finished
|
||||
```
|
||||
|
||||
End with an example of getting some data out of the system or using it for a little demo
|
||||
|
||||
## Running the tests
|
||||
|
||||
Explain how to run the automated tests for this system
|
||||
|
||||
### Break down into end to end tests
|
||||
|
||||
Explain what these tests test and why
|
||||
|
||||
```
|
||||
Give an example
|
||||
```
|
||||
|
||||
### And coding style tests
|
||||
|
||||
Explain what these tests test and why
|
||||
|
||||
```
|
||||
Give an example
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
Add additional notes about how to deploy this on a live system
|
||||
|
||||
## Built With
|
||||
|
||||
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
|
||||
* [Maven](https://maven.apache.org/) - Dependency Management
|
||||
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
|
||||
|
||||
## Contributing
|
||||
|
||||
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
|
||||
|
||||
## Versioning
|
||||
|
||||
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
|
||||
|
||||
## Authors
|
||||
|
||||
* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
|
||||
|
||||
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
|
||||
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
* Hat tip to anyone whose code was used
|
||||
* Inspiration
|
||||
* etc
|
||||
Reference in New Issue
Block a user