Browse Source

Improved README, CONTRIBUTING

main
Unbewohnte 3 years ago
parent
commit
32edf0d4ee
  1. 19
      CONTRIBUTING.md
  2. 15
      README.md

19
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/)
```
__ __ <Thank you !>
| \ / | ()
| \____/ | ()
|__// V \\__|
/|| ᗜ ᗜ || \
\_\\_︶_//_/
jj⑨lll
()_/@V@V@V\_()
/@V@V@V@V\
(_)-----(_)
```

15
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~~

Loading…
Cancel
Save