From 71510c452fabed78fe1a615fa36f56d07694477b Mon Sep 17 00:00:00 2001 From: Eduard Urbach Date: Mon, 6 May 2019 16:24:44 +0900 Subject: [PATCH] Use akyoto/readme --- README.md | 47 +++++++++++++--------- README.src.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 133 insertions(+), 19 deletions(-) create mode 100644 README.src.md diff --git a/README.md b/README.md index 89cbf1c7..f1336b75 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Anime Notifier +# notify.moe -[![Godoc reference][godoc-image]][godoc-url] -[![Go report card][goreportcard-image]][goreportcard-url] +[![Godoc][godoc-image]][godoc-url] +[![Report][report-image]][report-url] [![Tests][tests-image]][tests-url] -[![Code coverage][codecov-image]][codecov-url] -[![License][license-image]][license-url] +[![Coverage][coverage-image]][coverage-url] +[![Patreon][patreon-image]][patreon-url] ## How to @@ -82,10 +82,7 @@ docker attach notify.moe Create a bookmark in your browser and set this code as the URL: ```js -javascript:(() => { - location = location.href.indexOf('://beta.') === -1 ? - location.href.replace('://', '://beta.') : location.href.replace('://beta.', '://'); -})(); +javascript:(() => )(); ``` Clicking this bookmark will let you switch between `notify.moe` (live) and `beta.notify.moe` (development). @@ -106,19 +103,31 @@ Please read [CONTRIBUTING.md](https://github.com/animenotifier/notify.moe/blob/g This project is licensed under the [MIT License](https://github.com/animenotifier/notify.moe/blob/go/LICENSE). +## Coding style + +Please take a look at the [style guidelines](https://github.com/akyoto/quality/blob/master/STYLE.md) if you'd like to make a pull request. + +## Patrons + +| [![Scott Rayapoullé](https://avatars3.githubusercontent.com/u/11772084?s=70&v=4)](https://github.com/soulcramer) | +|---| +| [Scott Rayapoullé](https://github.com/soulcramer) | + +Want to see [your own name here](https://www.patreon.com/eduardurbach)? + ## Author | [![Eduard Urbach on Twitter](https://gravatar.com/avatar/16ed4d41a5f244d1b10de1b791657989?s=70)](https://twitter.com/eduardurbach "Follow @eduardurbach on Twitter") | |---| | [Eduard Urbach](https://eduardurbach.com) | -[godoc-image]: https://godoc.org/github.com/animenotifier/notify.moe?status.svg -[godoc-url]: https://godoc.org/github.com/animenotifier/notify.moe -[goreportcard-image]: https://goreportcard.com/badge/github.com/animenotifier/notify.moe -[goreportcard-url]: https://goreportcard.com/report/github.com/animenotifier/notify.moe -[tests-image]: https://cloud.drone.io/api/badges/animenotifier/notify.moe/status.svg -[tests-url]: https://cloud.drone.io/animenotifier/notify.moe -[codecov-image]: https://codecov.io/gh/animenotifier/notify.moe/branch/go/graph/badge.svg -[codecov-url]: https://codecov.io/gh/animenotifier/notify.moe -[license-image]: https://img.shields.io/badge/license-MIT-blue.svg -[license-url]: https://github.com/animenotifier/notify.moe/blob/go/LICENSE +[godoc-image]: https://godoc.org/github.com/blitzprog/home?status.svg +[godoc-url]: https://godoc.org/github.com/blitzprog/home +[report-image]: https://goreportcard.com/badge/github.com/blitzprog/home +[report-url]: https://goreportcard.com/report/github.com/blitzprog/home +[tests-image]: https://cloud.drone.io/api/badges/blitzprog/home/status.svg +[tests-url]: https://cloud.drone.io/blitzprog/home +[coverage-image]: https://codecov.io/gh/blitzprog/home/graph/badge.svg +[coverage-url]: https://codecov.io/gh/blitzprog/home +[patreon-image]: https://img.shields.io/badge/patreon-donate-green.svg +[patreon-url]: https://www.patreon.com/eduardurbach diff --git a/README.src.md b/README.src.md new file mode 100644 index 00000000..4931fd9b --- /dev/null +++ b/README.src.md @@ -0,0 +1,105 @@ +# {name} + +{go:header} + +## How to + +### Prerequisites + +* Install [Docker](https://www.docker.com/get-started) +* Install [Docker Compose](https://docs.docker.com/compose/install/) + +### Installation + +Download the source code: + +```shell +git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe +``` + +Download the developer tools: + +```shell +docker pull animenotifier/notify.moe +``` + +Start the developer tools: + +```shell +docker-compose up -d +``` + +Attach to a terminal: + +```shell +docker attach notify.moe +``` + +### Start the server + +* Enter the notify.moe directory: `cd notify.moe` +* Download dependencies: `go mod download` +* Compile TypeScript files using: `tsc` +* Start the web server using: `run` + +### Networking + +* Add `beta.notify.moe 127.0.0.1` to your `hosts` file + +### In your browser + +* Open the settings, search for certificates +* Import the file `security/default/root.crt` as a trusted Root authority +* Open `https://beta.notify.moe` + +### Tips + +* You can detach from the terminal using `Ctrl P -> Ctrl Q`. +* If you need to shutdown everything, use `docker-compose down`. +* Your home directory is mounted as `/my` inside Docker. +* Fork the notify.moe repository and upload your changes to the fork. +* Clone all the repositories you use into a `projects` directory inside your home files. +* The `run` binary is a file watcher that will restart the web server when it detects code changes. +* File modification events [don't work](https://github.com/docker/for-win/issues/56) on Docker for Windows. +* Use an editor like [Visual Studio Code](http://code.visualstudio.com) to access the source code on the host. +* To automatically compile TypeScript files in VS Code, press `Ctrl Shift B` and select `tsc: watch`. +* Use a Linux system for maximum performance. + +### What now? + +* Try the [example task for newcomers](docs/new-contributor-task.md). +* Install Pug/Jade and Stylus extensions for your editor. +* If you're **not** using VS Code, map Pug/Jade to `.pixy` and Stylus to `.scarlet` files (they're similar). +* Make some changes and upload them to your fork. +* Create a pull request on this repository (with the diffs of your fork). + +### Bookmark + +Create a bookmark in your browser and set this code as the URL: + +```js +javascript:(() => { + location = location.href.indexOf('://beta.') === -1 ? + location.href.replace('://', '://beta.') : location.href.replace('://beta.', '://'); +})(); +``` + +Clicking this bookmark will let you switch between `notify.moe` (live) and `beta.notify.moe` (development). + +## Find us + +* [Discord](https://discord.gg/0kimAmMCeXGXuzNF) +* [Facebook](https://www.facebook.com/animenotifier) +* [Twitter](https://twitter.com/animenotifier) +* [Docker](https://hub.docker.com/r/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. + +## License + +This project is licensed under the [MIT License](https://github.com/animenotifier/notify.moe/blob/go/LICENSE). + +{go:footer}