Skip to content

Commit

Permalink
intial readme content
Browse files Browse the repository at this point in the history
  • Loading branch information
fukawi2 committed Oct 3, 2018
1 parent 06efe09 commit 8666603
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,49 @@
# podnounce
Open-source web-based podcast publishing tool, supporting multiple shows.

## Getting Started

These instructions will get you a copy PodNounce up and running for your own use.

### Prerequisites
PodNounce runs on any basic Linux server with common infrastructure:

- Linux server (physical or virtual)
- Web Server (eg, *nginx* or *apache*)
- PostgreSQL Server
- PHP 5.4 or later

### Installing

1. Download a release tarball.
2. Extract to your document root (eg, `/var/www/html/`)
3. Create a database and populate with the schema:
```
createdb podnounce
psql podnounce < postgresql-schema.sql
```
4. Open your web browser and point it to your web server. The installation process should automatically start.

## Built With

* [Fat-Free Framework](https://fatfreeframework.com) - The PHP framework
* [Spectre.css](https://picturepan2.github.io/spectre/) - CSS Boilerplate
* [Composer](https://getcomposer.org/) - PHP Dependency Management

## Contributing

Any contributions should follow the [GitHub Flow](https://help.github.com/articles/github-flow/), and you must accept licensing your code under the MIT License in line with the rest of the project.

## Authors

* **Phillip Smith** - *Project Maintainer* - [fukawi2](https:/fukawi2)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

## Acknowledgments

* [Anthony Ferrara](https:/ircmaxell) for password hashing compatibility library.
* [Emanuil Rusev](https:/erusev/) for MarkDown rendering library.
* zedwood.com for the MP3File class to help process media files.

0 comments on commit 8666603

Please sign in to comment.