Skip to content

Add installation info from metafacture/metafacture-documentation/pull/56 #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Since [Metafacture Fix](https://github.com/metafacture/metafacture-fix) is intro
It should help you to get accustomed with Metafacture Core and Metafacture Fix.
Have fun.

The content pages can be found [in `/docs/`](/docs/)

Lesson plan:

[01 Introducing metafacture](./docs/01_Introducing_Metafacture.md)
Expand All @@ -37,3 +39,26 @@ Lesson plan:

[11 Mapping Marc to Dublin Core](./docs/11_MARC_to_Dublin_Core.html)

## Testing

### Installation
sudo apt remove ruby-bundler; sudo apt purge jekyll; sudo apt update; sudo apt install build-essential; bundle install; bundle exec jekyll serve

If you are on debian derivates go install build-essentials:
```
sudo apt install build-essential
```
Then you can use the Ruby Dependency Management to build all you need:
```
bundle install
```
Start jekyll like this:
```
bundle exec jekyll serve
```
If you experience troubles, make sure to not have jekyll installed via you
package manager. Also remove ruby-bundler. On debian derivates do:
```
sudo apt purge jekyll; sudo apt remove ruby-bundler
```