Docker config is now in its own repository
This commit is contained in:
60
docker/README.md
Normal file
60
docker/README.md
Normal file
@ -0,0 +1,60 @@
|
||||
# animenotifier/notify.moe
|
||||
|
||||
This is a fully pre-configured development environment for Anime Notifier development (notify.moe).
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisities
|
||||
|
||||
In order to run this container you'll need docker installed.
|
||||
|
||||
* [Linux](https://docs.docker.com/linux/started/)
|
||||
* [Mac](https://docs.docker.com/mac/started/)
|
||||
* [Windows](https://docs.docker.com/windows/started)
|
||||
|
||||
### Usage
|
||||
|
||||
#### Download the image
|
||||
|
||||
```shell
|
||||
docker pull animenotifier/notify.moe
|
||||
```
|
||||
|
||||
#### Boot up the dev environment
|
||||
|
||||
Download the notify.moe repository to get access to the docker-compose configuration. Run the following inside the repository:
|
||||
|
||||
```shell
|
||||
docker-compose run notify.moe
|
||||
```
|
||||
|
||||
#### Volumes
|
||||
|
||||
* `/my` - Your home directory
|
||||
|
||||
## Built With
|
||||
|
||||
* Arch Linux
|
||||
* Aero
|
||||
* Git
|
||||
* ...any many others.
|
||||
|
||||
## Find Us
|
||||
|
||||
* [Discord](https://github.com/animenotifier/notify.moe)
|
||||
* [GitHub](https://github.com/animenotifier/notify.moe)
|
||||
|
||||
## Contributing
|
||||
|
||||
Please read [CONTRIBUTING.md](https://github.com/animenotifier/notify.moe/blob/go/CONTRIBUTING.md) for details on how to contribute to this project.
|
||||
|
||||
## Authors
|
||||
|
||||
* **Eduard Urbach** - [eduardurbach.com](https://eduardurbach.com)
|
||||
|
||||
See also the list of [contributors](https://github.com/animenotifier/notify.moe/graphs/contributors) who
|
||||
participated in this project.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/animenotifier/notify.moe/blob/go/LICENSE) file for details.
|
Reference in New Issue
Block a user