readme

LICENSE

+MIT License
+
+Copyright (c) 2021 MyCard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,7 +4,23 @@ Ansible playbook file for deploying router of next generation.
 
 ## Requirements
 
-* `./dnsmasq-china-list`
+* `./prepare.sh` to download them.
+
+## How to use
+
+Use [mycard-deploy](https://code.mycard.moe/mycard/mycard-deploy) to start. Ansible 2.9 recommended.
+
+## Playbooks
+
+### Before moving the router to the place
+
+* `install.yaml` Installs the environment of router.
+
+* `network.yaml` Sets up the network config. This can be run without setting the router into the correct place.
+
+### After moving the router
+
+* `services.yaml` Sets up other services of the router.
 
 ## Marks in NextGen