-
Notifications
You must be signed in to change notification settings - Fork 172
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #196 from alyssafoglia/master
Created README.md file. Thx Alyssa
- Loading branch information
Showing
2 changed files
with
104 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
|
|
||
| # ATutor Readme: | ||
|
|
||
| ## About | ||
|
|
||
| ATutor is a learning management system to continue professional development for teachers, career developers, and academic research. It is written in PHP in a cross platform operating system. | ||
|
|
||
| ## Features | ||
| Two accessibility features in the system are text alternatives for all visual elements and keyboard access to all elements of the program. With these features, a blind person can listen to the entire interface of the system with the help of a screen reader, and he or she can access the system without needing a mouse. These features also allow ATutor to adapt to a wide variety of technologies including cell phones, personal data assistants (PDAs), and text-based Web browsers, to name a few. ATutor is also designed for adaptability to any of several teaching and learning scenarios. There are four main areas that reflect this design principle: themes, privileges, tool modules, and groups | ||
|
|
||
| ## Installation | ||
|
|
||
| To install ATutor, point your web browser to the installation directory where ATutor was extracted, and follow the Installer's instructions. | ||
| e.g. http://localhost/ATutor | ||
|
|
||
| *For full installation instructions see:* https://atutor.github.io/atutor/docs/installation | ||
|
|
||
| ### Installing from a Github Clone | ||
|
|
||
| 1. Fork ATutor into your own Github account, at: https://github.com/atutor/ATutor | ||
|
|
||
| 2. Clone ATutor from the fork you created into the document root of your webserver (for convenience), with:git clone https://github.com/yourname/ATutor.git | ||
|
|
||
| 3. Before running the Installer, create an empty config.inc.php file in the ATutor/include/ directory. If you have a command line to work from, while located in the ATutor directory, create the file with: touch include/config.inc.php | ||
|
|
||
| 4. Follow the installation instructions at the link above. | ||
|
|
||
| 5. Or, follow the instructions given by the ATutor Installer. | ||
|
|
||
| ## How to contribute | ||
|
|
||
| If you want to contribute to ATutor follow the instructions below or on https://atutor.github.io/atutor/docs/dev_with_github.html | ||
| 1. Fork the repository and create clone | ||
| 2. Create a new branch to work in | ||
| 3. Edit and create new files within your new branch | ||
| 4. Make sure your branch is up to date with the master branch | ||
| 5. Merge pull requests into master branch | ||
|
|
||
| For additional ATutor documentation, see the ATutor Handbook in ATutor, or at the following links: | ||
|
|
||
| - Administrators | ||
| https://atutor.github.io/atutor/handbook/admin.html | ||
|
|
||
| - Instructors: | ||
| https://atutor.github.io/atutor/handbook/instructor.html | ||
|
|
||
| - Users: | ||
| https://atutor.github.io/atutor/handbook/users.html | ||
|
|
||
| ## Developers | ||
|
|
||
| - Inclusive Design Research Centre | ||
| - OCAD University | ||
| - ATutorSpaces | ||
|
|
||
| ## License | ||
|
|
||
| GPL | ||
|
|
||
| ## [Website Link](https://atutor.github.io/) | ||
|
|
||
| ## [Report Issues](https://github.com/atutor/ATutor/issues) | ||
|
|
||
| ----------- | ||
| Have fun, and take it places! | ||
|
|
||
| -Greg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,55 @@ | ||
| ATutor readme: | ||
|
|
||
| To install ATutor, point your web browser to the installation directory where ATutor was extracted, and follow the Installer's instructions. | ||
| e.g. http://localhost/ATutor | ||
| # ATutor readme: | ||
|
|
||
| For full installation instructions see: | ||
| https://atutor.github.io/atutor/docs/installation | ||
| ## About | ||
|
|
||
| Installing from a Github Clone (assuming you know Github) | ||
| ATutor is a learning management system to continue professional development for teachers, career developers, and academic research. It is written in PHP in a cross platform operating system. | ||
|
|
||
| 1. Fork ATutor into your own Github account, at: | ||
| https://github.com/atutor/ATutor | ||
| ## Installation | ||
|
|
||
| 2. Clone ATutor from the fork you created into the document root of your webserver (for convenience), with: | ||
| git clone https://github.com/yourname/ATutor.git | ||
| To install ATutor, point your web browser to the installation directory where ATutor was extracted, and follow the Installer's instructions. | ||
| e.g. http://localhost/ATutor | ||
|
|
||
| 3. Before running the Installer, create an empty config.inc.php file in the ATutor/include/ directory. If you have a command line to work from, while located in the ATutor directory, create the file with: | ||
| *For full installation instructions see:* https://atutor.github.io/atutor/docs/installation | ||
|
|
||
| touch include/config.inc.php | ||
| ### Installing from a Github Clone | ||
|
|
||
| 1. Fork ATutor into your own Github account, at: https://github.com/atutor/ATutor | ||
|
|
||
| 4. Follow the installation instructions at the link above. | ||
| 2. Clone ATutor from the fork you created into the document root of your webserver (for convenience), with:git clone https://github.com/yourname/ATutor.git | ||
|
|
||
| 5. Or, follow the instructions given by the ATutor Installer. | ||
| 3. Before running the Installer, create an empty config.inc.php file in the ATutor/include/ directory. If you have a command line to work from, while located in the ATutor directory, create the file with: touch include/config.inc.php | ||
|
|
||
| GitHub Basics | ||
| If you want to contribute to ATutor, a few Git basics will describe how. | ||
| See: https://atutor.github.io/atutor/docs/dev_with_github.html | ||
| 4. Follow the installation instructions at the link above. | ||
|
|
||
| 5. Or, follow the instructions given by the ATutor Installer. | ||
|
|
||
| ## How to contribute | ||
|
|
||
| If you want to contribute to ATutor, visit: https://atutor.github.io/atutor/docs/dev_with_github.html | ||
|
|
||
| For additional ATutor documentation, see the ATutor Handbook in ATutor, or at the following links: | ||
|
|
||
| Administrators | ||
| https://atutor.github.io/atutor/handbook/admin.html | ||
| - Administrators | ||
| https://atutor.github.io/atutor/handbook/admin.html | ||
|
|
||
| - Instructors: | ||
| https://atutor.github.io/atutor/handbook/instructor.html | ||
|
|
||
| Instructors: | ||
| https://atutor.github.io/atutor/handbook/instructor.html | ||
| - Users: | ||
| https://atutor.github.io/atutor/handbook/users.html | ||
|
|
||
| ## Developers | ||
|
|
||
| - Inclusive Design Research Centre | ||
| - OCAD University | ||
| - ATutorSpaces | ||
|
|
||
| Users: | ||
| https://atutor.github.io/atutor/handbook/users.html | ||
| ## License | ||
|
|
||
| GPL | ||
|
|
||
| ----------- | ||
| Have fun, and take it places! | ||
|
|
||
| greg | ||
| -Greg |