From 32edf0d4eeb96bb6b77e36d59656cb5f123527dc Mon Sep 17 00:00:00 2001 From: Unbewohnte Date: Fri, 20 Aug 2021 11:55:48 +0300 Subject: [PATCH] Improved README, CONTRIBUTING --- CONTRIBUTING.md | 19 +++++++++++++++++++ README.md | 15 +++++++-------- 2 files changed, 26 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e6e6ea8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Thank you for being interested in contributing to fumosay ! + +Fumosay is very small, so it's not like there's a lot work involved to ask for help, but +I will be very thankful to you if you decide to add some new fumos in fumofiles ! + +If you don`t know what steps to follow in order to start contributing: [consider to look here](https://www.dataschool.io/how-to-contribute-on-github/) + +``` + __ __ + | \ / | () + | \____/ | () + |__// V \\__| + /|| ᗜ ᗜ || \ + \_\\_︶_//_/ + jj⑨lll + ()_/@V@V@V\_() + /@V@V@V@V\ + (_)-----(_) +``` \ No newline at end of file diff --git a/README.md b/README.md index 860d898..753f08d 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ run installation script --- -## Use +# Use ``` fumosay message_here ``` @@ -72,11 +72,10 @@ uses a non-default path to fumofiles and a custom fumofile --- -## TODO list +# TODO list -- ❌ Add more fumos -- ❌ Make it possible to use other fumos -- ❌ Improve message {box|bubble} -- somewhat ✅ Embed fumofiles or take care of ways of locating them -- ❌ Create a {deb|rpm} package -- ❌ Make an `install.sh` script +- Add more fumos +- ~~Make it possible to use other fumos~~ +- Improve message {box|bubble} +- ~~Embed fumofiles or take care of ways of locating them~~ +- ~~Make an `install.sh` script~~