Update README etc. (#112)

samwilson · Aug 22, 2021 · 0e21652 · 0e21652
1 parent 9f2d028
commit 0e21652
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -3,30 +3,7 @@ Twyne
 
 A web-based journal for writing and photography.
 
-![CI](https://github.com/samwilson/twyne/workflows/CI/badge.svg)
+The user manual is at [twyne.readthedocs.io](https://twyne.readthedocs.io/).
 
-## Requirements
-
-* PHP (7.3 or above)
-* MariaDB (10.3 or above) or MySQL (5.7 or above)
-* Shell access
-
-## Installation
-
-1. Clone: `git clone https://github.com/samwilson/twyne`
-2. Install: `cd twyne` then `composer install`
-3. Edit the details in `.env.local`:
-
-       APP_ENV=prod
-       APP_SECRET=random-string-here
-       DATABASE_URL=mysql://dbuser:dbpass@localhost:3306/twyne?serverVersion=5.7
-
-4. Create the database (if needed): `./bin/console doctrine:database:create`
-5. Install the database: `./bin/console doctrine:migrations:migrate`
-6. Open the site in a browser. The first account you create will be the administrator.
-
-## Usage
-
-Documentation will be available at [twyne.github.io](https://twyne.github.io/).
-
-A [Twyne command-line client](https://github.com/samwilson/twyne-client) is also available.
+[![Documentation Status](https://readthedocs.org/projects/twyne/badge/?version=latest)](https://twyne.readthedocs.io/en/latest/?badge=latest)
+[![CI](https://github.com/samwilson/twyne/workflows/CI/badge.svg)](https://github.com/samwilson/twyne/actions/workflows/ci.yml)
diff --git a/docs/install.rst b/docs/install.rst
@@ -7,9 +7,10 @@ Prerequesites
 To install Twyne, you need the following:
 
 1. a web server with PHP 7.3 or above;
-2. command-line access to that server;
-3. the `Git`_ version control system; and
-4. the PHP package manager, `Composer`_.
+2. MariaDB (10.3 or above) or MySQL (5.7 or above)
+3. command-line access to that server;
+4. the `Git`_ version control system; and
+5. the PHP package manager, `Composer`_.
 
 .. _`Git`: https://git-scm.com/
 .. _`Composer`: https://getcomposer.org/

diff --git a/templates/base.html.twig b/templates/base.html.twig
@@ -58,7 +58,7 @@
                     </div>
                 {% endif %}
                 <p class="powered-by">
-                    Powered by <a href="https://github.com/samwilson/twyne">Twyne</a>
+                    Powered by <a href="https://twyne.readthedocs.io/">Twyne</a>
                     <dfn title="Current application version">{{ git_tag() }}</dfn>
                 </p>
             </div>