Update README.md, .gitignore and settings organization
This commit is contained in:
parent
12ae628d1a
commit
1b91a31c1f
|
@ -1,6 +1,10 @@
|
||||||
|
### Project specific ###
|
||||||
|
|
||||||
|
config.php
|
||||||
*.db
|
*.db
|
||||||
*~
|
*~
|
||||||
*.secret
|
*.secret
|
||||||
|
include/settings.php
|
||||||
|
|
||||||
### Vim ###
|
### Vim ###
|
||||||
# Swap
|
# Swap
|
||||||
|
|
21
README.md
21
README.md
|
@ -1,21 +1,28 @@
|
||||||
|
# Librecat
|
||||||
|
|
||||||
Librecat is a ask.fm/curiouscat clone but FLOSS. It tries to be as minimal as possible while being a comfortable alternative to those mentioned while not using JS (at least for default theme).
|
Librecat is a ask.fm/curiouscat clone but FLOSS. It tries to be as minimal as possible while being a comfortable alternative to those mentioned while not using JS (at least for default theme).
|
||||||
|
|
||||||
It's PHP based, only depending on the sqlite3 php extension.
|
It's PHP based, only depending on the SQLite3 PHP extension.
|
||||||
|
|
||||||
# Features
|
## Features
|
||||||
|
|
||||||
- Fancy URL handling (opt-in)
|
- Fancy URL handling (opt-in)
|
||||||
- Social media response posting (mastodon API and Twitter support)
|
- Social media response posting (Mastodon API and Twitter support)
|
||||||
- Custom theme support
|
- Custom theme support
|
||||||
- No JS used by default
|
- No JS used by default
|
||||||
|
|
||||||
# URL Rewrites
|
## Installing
|
||||||
|
|
||||||
URL Rewrites are optional, but recommended for a more polished look. They can be activated in ```include/config.php``` with proper http server rewrite rules configurations.
|
1. Choose the web server you want, install PHP and PHP's SQLite3 extension.
|
||||||
|
2. Copy ```include/settings.php.default``` to ```include/settings.php``` and customize the options you want
|
||||||
|
|
||||||
|
## URL Rewrites
|
||||||
|
|
||||||
|
URL Rewrites are optional, but recommended for a more polished look. They can be activated in ```include/settings.php``` with proper http server rewrite rules configurations.
|
||||||
|
|
||||||
For now there's only Nginx implementation of those. Feel free to contribute since they're a little messy (but they work as expected)
|
For now there's only Nginx implementation of those. Feel free to contribute since they're a little messy (but they work as expected)
|
||||||
|
|
||||||
## Nginx
|
### NGINX
|
||||||
|
|
||||||
``` nginx
|
``` nginx
|
||||||
rewrite ^/$ /index.php last;
|
rewrite ^/$ /index.php last;
|
||||||
|
@ -28,6 +35,6 @@ rewrite ^/(.*)\.(.*)$ /$1.$2 last;
|
||||||
rewrite ^/(.*)$ /$1.php last;
|
rewrite ^/(.*)$ /$1.php last;
|
||||||
```
|
```
|
||||||
|
|
||||||
# Contributing
|
## Contributing
|
||||||
|
|
||||||
Pull requests and issues are welcome
|
Pull requests and issues are welcome
|
||||||
|
|
|
@ -0,0 +1,10 @@
|
||||||
|
<?php
|
||||||
|
// To activate this you have to put
|
||||||
|
// NGINX's redirect directives. The
|
||||||
|
// service is perfectly functional
|
||||||
|
// with this as false
|
||||||
|
|
||||||
|
$fancy_urls = false;
|
||||||
|
$theme_name = "minimalpunk";
|
||||||
|
|
||||||
|
?>
|
Loading…
Reference in New Issue