Skip to content

Commit

Permalink
quick readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
evanwill committed Feb 6, 2024
1 parent d6216b1 commit 4f6976c
Showing 1 changed file with 9 additions and 16 deletions.
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,16 @@
# CollectionBuilder-CSV
# cb-translate

CollectionBuilder-CSV is a robust and flexible "stand alone" template for creating digital collection and exhibit websites using Jekyll and a metadata CSV.
Driven by your collection metadata, the template generates engaging visualizations to browse and explore your objects.
The resulting static site can be hosted on any basic web server (or built automatically using GitHub Actions).
cb-translate is a prototype template forked from [CollectionBuilder-CSV](https://github.com/CollectionBuilder/collectionbuilder-csv) that aims to add translations for the collection website interface.

Visit the [CollectionBuilder Docs](https://collectionbuilder.github.io/cb-docs/) for step-by-step details for getting started and building collections!
CB-CSV was originally written in English, but has been manually translated by users into a variety of languages for their local use case.
cb-translate will make that process easier by allowing users to configure the site output language in "_config.yml".
Translations for the text/labels used in the user interface will be contained in the file "_data/translations.yml".
The template uses Liquid variables to put the configured language label into the page.

## Brief Overview of Building a Collection
This is an active project, so please expect changes!
Check the "docs/" folder in this repository for details of using the new features.

The [CollectionBuilder Docs](https://collectionbuilder.github.io/cb-docs/) contain detailed information about building a collection from start to finish--including installing software, using Git/GitHub, preparing digital objects, and formatting metadata.
However, here is a super quick overview of the process:

- Make your own copy of this template repository by clicking the green "Use this Template" button on GitHub (see [repository set up docs](https://collectionbuilder.github.io/cb-docs/docs/repository/)). This copy of the template is the starting point for your "project repository", i.e. the source code for your digital collection site!
- Prepare your collection metadata following the CB-CSV template (see our demo [metadata template on Google Sheets](https://docs.google.com/spreadsheets/d/1nN_k4JQB4LJraIzns7WcM3OXK-xxGMQhW1shMssflNM/edit?usp=sharing) and [metadata docs](https://collectionbuilder.github.io/cb-docs/docs/metadata/csv_metadata/)). Your metadata will include links to your digital files (images, pdfs, videos, etc) and thumbnails wherever they are hosted.
- Add your metadata as a CSV to your project repository's "_data" folder (see [upload metadata docs](https://collectionbuilder.github.io/cb-docs/docs/metadata/uploading/)).
- Edit your project's "_config.yml" with your collection information (see [site configuration docs](https://collectionbuilder.github.io/cb-docs/docs/config/)). Additional customization is done via a theme file, configuration files, CSS tweaks, and more--however, once your "_config.yml" is edited your site is ready to be previewed.
- Generate your site using Jekyll! (see docs for how to [use Jekyll locally](https://collectionbuilder.github.io/cb-docs/docs/repository/generate/) and [deploy on the web](https://collectionbuilder.github.io/cb-docs/docs/deploy/))

Please feel free to ask questions in the main [CollectionBuilder discussion forum](https://github.com/CollectionBuilder/collectionbuilder.github.io/discussions).
This prototype starts from the work of @maehr (see [cb-csv 48](https://github.com/CollectionBuilder/collectionbuilder-csv/pull/48)) and @owikle.

----------

Expand Down

0 comments on commit 4f6976c

Please sign in to comment.