kerboul/perun
1
0
Fork 0
mirror of https://github.com/DaKerboul/perun.git synced 2026-08-09 15:55:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
simpo
2019-02-22 11:46:59 +01:00
committed by GitHub
parent 8d58bfd425
commit c9052a931e
1 changed files with 18 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@@ -4,77 +4,46 @@ This toolset extracts data from DCS World server and export it to local json fil
## Getting Started ## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. You can use this toolkit with or without Windows app. Simple DCS export scripts will create JSON file which can be used for further processing.
### Prerequisites ### Prerequisites
What things you need to install the software and how to install them JSON Export:
* DCS World stable or DCS World beta
``` For UDP Export:
Give examples * Windows app which handles UDP readouts
```
For MySQL Export:
* MySQL server with read/write access
### Installing ### Installing
A step by step series of examples that tell you how to get a development env running * Copy contents of DCS folder to you \Scripts folder (inside DCS folder in your Saved Games)
Say what the step will be ## Testing
``` TBD
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 ## Built With
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used * [VisualStudio 2017 Community](https://visualstudio.microsoft.com/vs/community/)
* [Maven](https://maven.apache.org/) - Dependency Management * [Notepad++](https://notepad-plus-plus.org/)
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds * [TortoiseGit](https://tortoisegit.org/)
## Contributing ## 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. Please contact me if you'd like to contribute.
## Versioning ## 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). We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/szporwolik/perun/tags).
## Authors ## Authors
* **Szymon Porwolik** - *Initial work* - [szporwolik](https://github.com/szporwolik) * **Szymon Porwolik** - *Initial work* - [szporwolik](https://github.com/szporwolik)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. See also the list of [contributors](https://github.com/szporwolik/perun/contributors) who participated in this project.
## License ## License
@@ -82,6 +51,4 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md
## Acknowledgments ## Acknowledgments
* Hat tip to anyone whose code was used * Thanks to [Gildia DCS](https://forum.gildia.org) Polish community of DCS World pilots.
* Inspiration
* etc