spina-conferences-primer_theme-fork 0.10.0 → 1.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce68bf02784663a0e354ca369154d20f4599eae01c0910be10c57d6d330afba3
-  data.tar.gz: fe44d6649b68188d82fdd843b0a55d44b32bde8f89752513a152f61fd074ea2f
+  metadata.gz: 3f6a7caf015d10b4b0c43b0e99fa682a26da63c770b2d93ef4b11891e30b48c8
+  data.tar.gz: 4d95d757a0e0e4ee920e70ef564cd8729e223ba61091a8f464571791fb8d5df4
 SHA512:
-  metadata.gz: 193634c447d2d784f51be6787991e3754d178bc78998de0a4c0dfd4171eeb5ad669fc1a13e7ac02fd2d288a254611213d6b72949360d547855c63e59707fca93
-  data.tar.gz: d337742e09e81dab12073e1a49a844e3d66612769e5bd7d9cb152beccfba1f3f629909bdc39ce8871fadfbd440e044c1ea2a9399e65e31e64b8965af0d15d7df
+  metadata.gz: f031b0f95f0f83b6740c7ac27f34b7d30c38c5fef26b96a17b10e7c592efff88362276d1733c69da93de6c2a3a42f17d1196f32565298edf1b4020e49ecbf55c
+  data.tar.gz: 1b0b5603a18de7dcf81f060b6ff8a27df9e08ca62e7527d41c87c71d455ad4a8b6b7d4849571119a9691bac18f4922000c81e2dd28202541f217318a963961bc

data/README.md

@@ -1,24 +1,39 @@
-# PrimerTheme: frontend for Spina
+# PrimerTheme for Spina
+
+PrimerTheme is a theme for Spina that uses [GitHub's Primer design system](https://primer.style/). It provides frontends for Spina pages, as well as for the following Spina plugins:
+
+- [Conferences](https://github.com/louis-vs/spina-admin-conferences-fork/)
+- [Journal](https://github.com/louis-vs/spina-admin-journal)
+- [Blog (fork)](https://github.com/louis-vs/spina-admin-conferences-blog)
+
+All of these plugins will be automatically installed with PrimerTheme, but you can use any selection of them that you wish. PrimerTheme provides you with an easy-to-setup Spina theme with a wide array of options, extending the core Spina setup.
+
+PrimerTheme was originally designed for the Undergraduate Linguistics Association of Britain's website, which you can [view here](https://www.ulab.org.uk/) if you want to see the theme in action.
+
+**NB:** Please use this fork, rather than the original. This fork provides a stable, updated release, whilst the old repo is no longer maintained.
 
 ![Rails tests](https://github.com/louis-vs/spina-conferences-primer_theme-fork/workflows/Verify/badge.svg?branch=master&event=push)
 [![codecov](https://codecov.io/gh/louis-vs/spina-conferences-primer_theme-fork/branch/master/graph/badge.svg?token=9TZ9QGGLAH)](https://codecov.io/gh/louis-vs/spina-conferences-primer_theme-fork)
 [![CodeFactor](https://www.codefactor.io/repository/github/louis-vs/spina-conferences-primer_theme-fork/badge)](https://www.codefactor.io/repository/github/louis-vs/spina-conferences-primer_theme-fork)
 [![Inline docs](http://inch-ci.org/github/louis-vs/spina-conferences-primer_theme-fork.svg?branch=master)](http://inch-ci.org/github/louis-vs/spina-conferences-primer_theme-fork)
 
-A plugin for `Spina` that provides a frontend for `Spina::Admin::Conferences`, `Spina::Admin::Journal`, and `Spina::Admin::Conferences::Blog` using components from `Primer::ViewComponents`.
+## Features
 
-This fork provides an updated version of the plugin, as the main repo is currently badly outdated.
+The plugin's main goal is to provide frontends for Spina core and the three plugins listed above, using Primer. It also provides a number of useful page templates for use with Spina.
 
 ## Usage
-See the READMEs for the conference plugin, the journal plugin, and the bog plugin, respectively, for more information on what kind of content this frontend allows you to create and how to do so within the admin interface. Also make sure to ensure compilation of the assets for this gem by adding the following line to your
-`manifest.js` file.
 
-```js
-//= link spina_conferences_primer_theme_manifest.js
-```
+See the READMEs for the conference plugin, the journal plugin, and the blog plugin, respectively, for more information on what kind of content this frontend allows you to create and how to do so within the admin interface.
+
+You can customise Primer by overriding the `_custom.sass` and `_custom_variables.sass` files. See the [ULAB Website](https://github.com/ulab-committee/ulab-website) repo for an example.
 
 ## Installation
-Add this line to your application's Gemfile:
+
+Make sure you have a working installation of Ruby on Rails 7. You can find a setup guide [here](https://guides.rubyonrails.org/getting_started.html).
+
+You then need to install Spina, following the guide [on the Spina website](https://spinacms.com/docs).
+
+To install the plugin, add this line to your application's Gemfile:
 
 ```ruby
 gem 'spina-conferences-primer_theme-fork', require: 'spina/conferences/primer_theme'
@@ -29,13 +44,46 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+You will also need to configure Yarn. Add this repo as a dependency, so that your `package.json` resembles the following:
+
+```json
+{
+  "name": "website_name",
+  "private": true,
+  "dependencies": {
+    "spina-conferences-primer-theme-fork": "louis-vs/spina-conferences-primer_theme-fork"
+  }
+}
+```
+
+You will then need to install and run the migrations from all of the plugins that come bundled with PrimerTheme:
+
+```bash
+$ bin/rails spina_admin_journal:install:migrations
+$ bin/rails spina_admin_conferences:install:migrations
+$ bin/rails spina_admin_conferences_blog:install:migrations
+$ bin/rails spina_conferences_primer_theme:install:migrations
+$ bin/rails db:migrate
+```
+
+Also make sure to ensure compilation of the assets for this gem by adding the following line to your `manifest.js` file.
+
+```js
+//= link spina_conferences_primer_theme_manifest.js
+```
+
+Finally, start the server with:
+
 ```bash
-$ gem install spina-conferences-primer_theme-fork
+$ bin/rails s
 ```
 
+If you want to customise Primer, you will need to add `_custom.sass` and/or `_custom_variables.sass` into `app/assets/stylesheets/spina/conferences/primer_theme`. You will also need to override the CSS build rake task so that it finds your new files - an example of this can be found in the ULAB website [here](https://github.com/ulab-committee/ulab-website/blob/master/lib/tasks/ulab_website_tasks.rake).
+
 ## Contributing
-Contributions welcome, open an issue first please.
+
+Bug reports and feature requests are welcome in the [Issues](https://github.com/louis-vs/spina-conferences-primer_theme-fork/issues) section. Translations are also very welcome!
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).