From c8e9356b2e1eac02e7a1b005bac8458749e6ba13 Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Sun, 5 Mar 2017 13:46:47 +0100 Subject: [PATCH] Replace original docs README.txt We need something that points back to the code now. --- docs/README.md | 7 +++++++ docs/README.txt | 30 ------------------------------ 2 files changed, 7 insertions(+), 30 deletions(-) create mode 100644 docs/README.md delete mode 100644 docs/README.txt diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..b197b26e3 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +# LibreTime Documentation + +The LibreTime documentation is created from this directory using `mkdocs`. You may read +it at [libretime.org](http://libretime.org). + +The canonical source of this documentation is in the [LibreTime repo](https://github.com/LibreTime/libretime) +in the [`docs/` subdir](https://github.com/LibreTime/libretime/tree/master/docs). diff --git a/docs/README.txt b/docs/README.txt deleted file mode 100644 index 2a2213aa1..000000000 --- a/docs/README.txt +++ /dev/null @@ -1,30 +0,0 @@ -README -====== - -This directory should be used to place project specfic documentation including -but not limited to project notes, generated API/phpdoc documentation, or -manual files generated or hand written. Ideally, this directory would remain -in your development environment only and should not be deployed with your -application to it's final production location. - - -Setting Up Your VHOST -===================== - -The following is a sample VHOST you might want to consider for your project. - - - DocumentRoot "/home/naomiaro/airtime/public" - ServerName airtime.local - - # This should be omitted in the production environment - SetEnv APPLICATION_ENV development - - - Options Indexes MultiViews FollowSymLinks - AllowOverride All - Order allow,deny - Allow from all - - -