Replace original docs README.txt

We need something that points back to the code now.
This commit is contained in:
Lucas Bickel 2017-03-05 13:46:47 +01:00
parent f2293828cb
commit c8e9356b2e
2 changed files with 7 additions and 30 deletions

7
docs/README.md Normal file
View File

@ -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).

View File

@ -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.
<VirtualHost *:80>
DocumentRoot "/home/naomiaro/airtime/public"
ServerName airtime.local
# This should be omitted in the production environment
SetEnv APPLICATION_ENV development
<Directory "/home/naomiaro/airtime/public">
Options Indexes MultiViews FollowSymLinks
AllowOverride All
Order allow,deny
Allow from all
</Directory>
</VirtualHost>