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

README #12

Open
tschimbr opened this issue Dec 19, 2016 · 4 comments
Open

README #12

tschimbr opened this issue Dec 19, 2016 · 4 comments
Assignees

Comments

@tschimbr
Copy link
Member

Make a short introduction and a "getting started" section: How to setup the application and the database.

@SamJa
Copy link
Contributor

SamJa commented Dec 23, 2016

Updated README.
Please check out, if you can run medlang with the instructions given.

@tschimbr
Copy link
Member Author

The most important thing: "How to get the data" is not yet solved. Where is medlang/medlang_data/dump? There is no instruction on how to initialize the submodule and the standard procedure is not working.
The first section of the README can be omitted as all versions are configured in the Gemfile and do not have to be configured manually. One just has to run bundle install. We might even confuse the reader as soon as the information in the README gets outdated which will happen sooner or later.

Step 2 was not necessary for me as there already exists a secrets.yml which is configured just fine for test and development. Instead you might describe how to create a .env file for storing secret tokens and password for production.

@tschimbr
Copy link
Member Author

Correction: The standard procedure using 'git submodule init' and 'git submodule update' is partially working: I do not yet have access rights for the repo.

@tschimbr
Copy link
Member Author

See my corrections here: 1128ac3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants