From d5f882303e14a1effee72b2f3e85a7045090e05a Mon Sep 17 00:00:00 2001 From: mio Date: Mon, 17 Sep 2018 05:42:14 +0000 Subject: [PATCH] Add README --- .gitignore | 3 ++- README.md | 21 +++++++++++++++++++++ ramenkan.py | 0 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 README.md mode change 100644 => 100755 ramenkan.py diff --git a/.gitignore b/.gitignore index 68e2598..937c912 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ __pycache__/ *$py.class *.swp -*config.yml +nohup.out +*/config.yml diff --git a/README.md b/README.md new file mode 100644 index 0000000..efefa8b --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# itte + +A very basic Python IRC bot script. + + +## Example: ramenkan + +- Edit `ramenkan/config.sample.yml` to change settings as appropriate. + +- Run: + + ``` + chmod +x ramenkan.py + nohup python3 ramenkan.py & + ctrl + c + ``` + + +## License + +AGPLv3 diff --git a/ramenkan.py b/ramenkan.py old mode 100644 new mode 100755