sose
/
shi
1
2
Fork 0
Code Issues Pull Requests Releases Wiki Activity

spelling

This commit is contained in:
sose 2019-10-16 22:29:15 -07:00
parent 758db56586
commit 0e22eb153d
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -17,17 +17,17 @@ the programming equivalent of a shitpost
- clone this repo
- cd to this repo
- `. ./console.sh` to start the shi console
- `start_listener` to start lisenting for posts
- `start_listener` to start listening for posts
- you might want to do `tail -f log.txt` in another terminal to see whats going on
### how backends work
- shi has a builtin framework for swappable backends both for post recieving and storage,
- shi has a builtin framework for swappable backends both for post receiving and storage,
currently there is:
- tar backend
- like the old version of shi
- recives tar files through nc and generates posts
- receives tar files through nc and generates posts
- bad
- dont use it
- don't use it
- http backend
- listens for an http POST request with form data
- allows user-friendly html post form
@ -40,7 +40,7 @@ currently there is:
- **how backends work**
- **listening**
- a backend is a shell script with a `listen` function
- this function is expected to coninuosly output post data it recives like so:
- this function is expected to continuously output post data it receives like so:
```
New post
board:<board name>
@ -55,7 +55,7 @@ End new post
- as long as the backend has a listen function that outputs data to stdout like this,
shi doesn't care where it comes from.
- **db**
- a db backend is simply a shell script provinding the following funtions:
- a db backend is simply a shell script providing the following functions:
- `path_to_post <post id>`
- `create post <board> <parent> <user> <title> <content> <image_name> <image_content> <post_id> <post_type>`
- `get_post_data <post_data_path> <item>
@ -98,7 +98,7 @@ otherwise declare the variable as empty and then set it to your operation
- boards
- where all the html for the boards is stored
- console.sh
- souce this to allow you to control shi
- source this to allow you to control shi
- globals.sh
- global variables (really just settings)
- inbox
@ -115,7 +115,7 @@ otherwise declare the variable as empty and then set it to your operation
- README.md
- this file
- reset.sh
- debug script that nukes all boards and completly resets shi
- debug script that nukes all boards and completely resets shi
- don't use this unless you've really screwed up
- shi.sh
- memories