update doc
This commit is contained in:
parent
14cc3ab431
commit
b46dc01dcb
1 changed files with 3 additions and 2 deletions
|
@ -3,6 +3,9 @@ An application allows you to mark any books, movies and more things you love.
|
||||||
|
|
||||||
Depends on Mastodon.
|
Depends on Mastodon.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
Please see [doc/GUIDE.md](doc/GUIDE.md)
|
||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
The project is based on Django. If you are familiar with this technique and willing to read through the terrible code😝, your contribution would be the most welcome!
|
The project is based on Django. If you are familiar with this technique and willing to read through the terrible code😝, your contribution would be the most welcome!
|
||||||
|
|
||||||
|
@ -11,8 +14,6 @@ Currently looking for someone to help with:
|
||||||
- Explaining the structure of code
|
- Explaining the structure of code
|
||||||
- Refactoring (this is something big)
|
- Refactoring (this is something big)
|
||||||
|
|
||||||
This project is still in its early stage, so you are not encouraged to deploy it on your own. If you do want to give it a try, please check the [fork of *alphatownsman*](https://github.com/alphatownsman/boofilsic), which is more friendly.
|
|
||||||
|
|
||||||
## Sponsor
|
## Sponsor
|
||||||
If you like this project, please consider sponsoring us on [Patreon](https://patreon.com/tertius).
|
If you like this project, please consider sponsoring us on [Patreon](https://patreon.com/tertius).
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue