Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
enridaga authored Feb 8, 2024
1 parent 4faf3b6 commit 47858fe
Showing 1 changed file with 20 additions and 23 deletions.
43 changes: 20 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
# Polifonia Ecosystem
# REECO Website

This project is under development. See
https://polifonia-project.github.io/ecosystem/ for the live version of this website.
## Setup and configuration

## Contributing

Configure `repositories.txt` with the info about where to extract reeco annotations. This is an example:
```bash
reeco-framwork/reeco-annotation-schema:main
reeco-framwork/reeco-jekyll:main
reeco-framwork/reeco-website-action:main
reeco-framwork/reeco-web-repo-validator:main
reeco-framwork/reeco-python:main
```

Commit changes (this should trigger a GH actions that downloads all data and builds the website)

## Need help with this procedure

Open an issue and ask for help!



## Development
The website is built with [Jekyll](https://jekyllrb.com/) and hosted on [Github
pages](https://pages.github.com/). It means that one needs to write the code on
their machine in a git repository and then push it on Github. Then, Github will
Expand Down Expand Up @@ -60,22 +76,3 @@ git clone [email protected]:polifonia-project/ecosystem.git

```

### Setup REECO


Configure `repositories.txt` with the info about where to extract reeco annotations. This is an example:
```bash
polifonia-project/rulebook:branches:main
polifonia-project/external-components:branches:main
polifonia-project/folk_ngram_analysis:branches:master
polifonia-project/clef:branches:master
polifonia-project/registry_app:branches:main
polifonia-project/lharp:branches:master
```

Commit changes (this should trigger a GH actions that downloads all data and builds the website)

## Need help with this procedure

Open an issue and ask for help!

0 comments on commit 47858fe

Please sign in to comment.