Skip to content
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

update readme #6

Open
1 of 5 tasks
dwhieb opened this issue Jan 29, 2021 · 0 comments
Open
1 of 5 tasks

update readme #6

dwhieb opened this issue Jan 29, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dwhieb
Copy link

dwhieb commented Jan 29, 2021

Update the readme to focus more specifically on ALTLab's fork.

  • links to Spraakbanken's documentation
  • ALTLab's branching structure
  • building and testing the app locally
  • fix status badge (and add new ones)
  • ALTLab-specific configuration settings (relationship between config.js, common.js, and default_mode.js); also add inline documentation for this

Our dev branch should actually update from Spraakbanken's master branch, because that's more well tested. We should avoid pulling from Spraakbanken's dev branch if possible. (See spraakbanken#160.) We'll keep a running dev branch, which issue branches should be made from.

@dwhieb dwhieb added the documentation Improvements or additions to documentation label Jan 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant