diff --git a/.gitignore b/.gitignore index 90ae1be18b..f3031c1274 100644 --- a/.gitignore +++ b/.gitignore @@ -28,6 +28,7 @@ writeup/ /content/*.mp4 /content/*.mp4.part /content/*.srt +/content/khan /data/logs /data/i18n /data/subtitles diff --git a/README.md b/README.md index 056511272c..179af6e1a9 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,14 @@ Official website: http://kalite.learningequality.org/ --- + +#### Documentation + +* Instructions for installation: [See: INSTALL.md](INSTALL.md) +* Further documentation: [See: our wiki](https://github.com/learningequality/ka-lite/wiki) + +--- + #### License information: The KA Lite sourcecode itself is open-source [MIT licensed](http://opensource.org/licenses/MIT), and the other included software and content is licensed as described in the [LICENSE](https://raw.github.com/learningequality/ka-lite/master/LICENSE) file. Please note that KA Lite is not officially affiliated with, nor maintained by, Khan Academy, but rather makes use of Khan Academy's open API and Creative Commons content, which may only be used for non-commercial purposes. diff --git a/docs/BIG-IDEAS-DEMO.md b/docs/BIG-IDEAS-DEMO.md deleted file mode 100644 index b3feaeea64..0000000000 --- a/docs/BIG-IDEAS-DEMO.md +++ /dev/null @@ -1,47 +0,0 @@ -___Setting up a Spanish-language demo___ -* To the file `ka-lite/kalite/local_settings.py`, add the following lines: - * `CENTRAL_SERVER_HOST = "kalite.learningequality.org:7007"` - * `SECURESYNC_PROTOCOL = "http"` - * `CACHE_TIME = 0` -* Run `scrape_videos -l es` to get all the dubbed videos -* Run `scrape_exercises -l es` to get all the localized exercises. -* Install the spanish language pack - * Start the server - * Log in as the admin user - * Go to Updates, choose "Manage" language packs. - * In the dropdown, select spanish, and click "get language pack" -* Select spanish as the default language - -DONE!!! - -___Want to have more language packs available?___ - -1. Log into the central server -2. In the `ka-lite-develop/kalite` folder, run `./manage.py update_language_packs -l [lang_code] - * Useful language codes: de (German), ar (Arabic), zh-CN (simplified Chinese), pt-BR (brazilian portuguese), en (english) -3. Go back to your distributed server, and refresh--you'll find the language packs there. - -___New commands___ -* `scrape_videos -l es` - [run on distributed server] download all known dubbed videos in spanish, from youtube, and save as mp4 - * NOTE: Only the following languages are supported: `da`, `he`, `pt-BR`, `tr`, `es` -* `scrape_exercises -l es` - [run on distributed server] download all exercises in spanish, from khan academy, and put them in the proper place for use. - - -___Download Videos___ - -Using this to download: http://rg3.github.io/youtube-dl/index.html - -This spreadsheet (or other list, wink-wink) to pick the videos: https://docs.google.com/a/learningequality.org/spreadsheet/ccc?key=0AhvqOn88FUVedEM5U3drY3E1MENfeWlLMVBnbnczT3c#gid=13 - -Sample command: youtube-dl --id -f mp4 www.youtube.com/watch?v=Pytw-oTpUNk -Downloaded: حل المعادلات التربيعية بالتحليل إلى العوامل-Pytw-oTpUNk.mp4 for me :) -rename the Pytw-oTpUNk.mp4 -DONE! - -___Download Localized Exercises___ - -1. Download https://es.khanacademy.org/khan-exercises/exercises/vertical_angles.html?lang=es -2. Put into the `ka-lite/kalite/static/js/khan-exercises/exercises/` folder to replace the english version -3. Repeat for all files in the directory! - -[note: this works!] diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md deleted file mode 100644 index f5e7bacd6a..0000000000 --- a/docs/DEVELOPMENT.md +++ /dev/null @@ -1,61 +0,0 @@ -How to contribute -=== - -Firstly, thank you for being willing to offer your time to contribute to the KA Lite efforts! The project is run by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference. Feel free to follow the instructions below to start playing with the codebase, but you'll probably want to [contact us](http://jamiealexandre.com/contact/) to figure out what would be good for you to work on. - -### Getting started - -1. Fork the main KA Lite repository (signing up for a GitHub account first, if needed). -2. Follow the [installation instructions](../INSTALL.md), except clone your own repo instead of the main repo: -(e.g. `git clone --recursive git@github.com:YOURACCOUNTNAME/ka-lite.git`) -3. Switch to the `develop` branch, which is where any commits you make should go: `git checkout develop` (we are roughly following the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/) conventions) -4. In the `ka-lite/kalite` directory, add a file called `local_settings.py`, and put `DEBUG = True` in it. -5. Open two terminal/shell windows, in the `ka-lite/kalite` directory. In one, run `python manage.py runserver` (to start the Django development server), and in the other, run `python manage.py cronserver 5` (to run the background processing script, which does things like download requested videos). - -Guidelines -=== - -### Priority on efficiency - -KA Lite is designed to function reasonably well on low power devices (such as a Raspberry Pi), meaning we want to avoid doing anything computationally intensive. Also, for the cross-device syncing operations, connection bandwidth and speed are often expensive and slow, so we should always try to minimize the amount of data needing to be transferred. - -### CSS - -The file `khan-site.css` is from khan-exercises, and we don't want to modify it, in case we want to update it from there in the future. Instead, most CSS styling goes in khan-lite.css, and will override any styles defined in `khan-site.css`. For styles that will only ever be used on a single page, they can be defined in a `