Skip to content

Commit

Permalink
update readme for atutor.github.io
Browse files Browse the repository at this point in the history
  • Loading branch information
gregrgay committed Mar 7, 2018
1 parent a793f23 commit 8445abe
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions readme
@@ -1,22 +1,32 @@
ATutor readme:

To install ATutor simply point your browser to your installation and follow the provided instructions.
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 additional installation details see:
For full installation instructions see:
https://atutor.github.io/atutor/docs/installation

Installing from a GitHub Clone
1. If you are installing ATutor from a GitHub clone, rather than an ATutor bundled distribution, follow the usual installation and upgrade instructions at the link above.
2. Before running the Installer, you will need to create an empty config file. To create the file, from the ATutor base directory, issue the command
Installing from a Github Clone (assuming you know Github)

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
3. Then follow the instruction given by the Installer.

GitHub Basics
If you wish to have code you've developed added to the ATutor public source code, you will need to understand a few Git basics.
4. Follow the installation instructions at the link above.

5. Or, follow the instructions given by the ATutor Installer.

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

Or, see the ATutor Handbook:
For additional ATutor documentation, see the ATutor Handbook in ATutor, or at the following links:

Administrators
https://atutor.github.io/atutor/handbook/admin.html
Expand Down

0 comments on commit 8445abe

Please sign in to comment.