Issue #3312696 by LeoAlcci, anoopsingh92, elber, lbonfioli, erikaagp: Make the... (f7e07046) · Commits · project / baguettebox

README.txt

+23 −17

Original line number	Diff line number	Diff line
		@@ -19,8 +19,8 @@ This module provides drupal integration with BaguetteBox library and
		REQUIREMENTS
		------------

		No other modules requirement for this module.
		Only library download from the library
		This module doesn't depend on any other modules.
		The only requirement is to download library
		from https://github.com/feimosi/baguetteBox.js.


		@@ -29,12 +29,13 @@ INSTALLATION
		=> Via Manual Mode:

		* Install as usual, see http://drupal.org/node/895232 for further information.
		* Download BaguetteBox library from https://github.com/feimosi/baguetteBox.js.
		Use exact same version as defined in baguettebox.libraries.yml file
		* Download the BaguetteBox library from
		https://github.com/feimosi/baguetteBox.js.
		Use the exact same version as defined in baguettebox.libraries.yml file
		* Unzip the library and place files to libraries directory.
		The directory structure should be as follows:
		/libraries/baguettebox.js/dist/baguetteBox.min.css
		/libraries/baguettebox.js/dist/baguetteBox.min.js
		/libraries/baguettebox.js/baguetteBox.min.css
		/libraries/baguettebox.js/baguetteBox.min.js

		=> Via Composer:

		@@ -54,26 +55,31 @@ INSTALLATION
		}
		}

		* Download BaguetteBox library from https://github.com/feimosi/baguetteBox.js.
		* Download the BaguetteBox library from
		https://github.com/feimosi/baguetteBox.js.
		Use exact same version as defined in baguettebox.libraries.yml file
		* Unzip the library and place files to libraries directory.
		The directory structure should be as follows:
		/libraries/baguettebox.js/dist/baguetteBox.min.css
		/libraries/baguettebox.js/dist/baguetteBox.min.js


		/libraries/baguettebox.js/baguetteBox.min.css
		/libraries/baguettebox.js/baguetteBox.min.js


		CONFIGURATION
		-------------

		* To configure this module, you need to create a
		new content type called "Baguette.box".
		After that, inside that content type, you need to create a field
		called "image" and change the format for "Baguete Box.
		* To configure this module, you need to create a new content type,
		In order to do this, go to Structure -> Content types -> Add Content type
		and call it "Baguette.box" and click save.

		The next step is to go to Manage Fields and then click on "Add field".
		In the new field, select "image" and fill the label with a significative
		name such as "Baguette Box Image".

		The last step is to go to "Manage display" and change,
		the format settings of the image style to "Baguette Box".

		* To make it work with Views, you should either set "Use field template"
		checkbox or manually add "baguettebox" class in View field style settings.
		* To make it work with Views, you should either set "Use field template"
		checkbox or manually add "baguettebox" class in View field style settings.


		MAINTAINERS