X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=CONTRIBUTING.md;h=b7311238a53cfb31bcb6da2a80b3acfcf6c9ba36;hb=HEAD;hp=66920189e9622517b4b14d6bbe41b36d2e12f983;hpb=7d33cc17bc343f43f81756a1008d6658a9ebb714;p=timetracker.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66920189..b7311238 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,32 @@ -# Short Links to Important Resources +# Resources + +* [docs](https://www.anuko.com/time_tracker/features.htm) - detailed documentation about this project (needs updating). +* [forum](https://www.anuko.com/forum/viewforum.php?f=4) - general discussion. -* [docs](https://www.anuko.com/time_tracker/features.htm) - detailed documentation about this project can be found here -* [bugs](https://github.com/anuko/timetracker/issues) - report bugs and issues here -* [forum](https://www.anuko.com/forum/viewforum.php?f=4) - for general discussion # Reporting Bugs -Create a [new issue](https://github.com/anuko/timetracker/issues). +* GitHub users: create a [new issue](https://github.com/anuko/timetracker/issues) here. +* Forum users: post a [new topic](https://www.anuko.com/forum/viewforum.php?f=4) here. +* Or, send us a [message](https://www.anuko.com/contact.htm). + # Reporting Security Issues -**#TODO** +* Use the [contact form](https://www.anuko.com/contact.htm) to report a vulnerability. +* Or send an encrypted email to security_at_anuko_dot_com. Public key to be published soon. -# Setting up a dev environment -Use docker to run dev instance: +# Setting up a Dev Environment + +Docker users: install both docker and docker-compose, then run a dev instance: ```bash docker-compose up ``` - -and then navigate to: http://localhost:8080. Default credentials for initial login are: +Navigate to: http://localhost:8080 to use Time Tracker. Default credentials for initial login are: ``` usr: admin psw: secret ``` -Full installation and setup guide can be found [here](https://www.anuko.com/time_tracker/install_guide/index.htm). +Without docker, perform a manual install of a web server, php, database server, and Time Tracker. Full installation and setup guide can be found [here](https://www.anuko.com/time_tracker/install_guide/index.htm).