diff --git a/docs/Autolabclireadme.md b/docs/Autolabclireadme.md new file mode 100644 index 0000000..d526f40 --- /dev/null +++ b/docs/Autolabclireadme.md @@ -0,0 +1,30 @@ +# AutoLab CLI # + +[](https://codeclimate.com/github/prasadtalasila/autolabcli) [](https://snyk.io/test/github/autolabjs/autolabcli) [](https://travis-ci.org/AutolabJS/autolabcli) + +A client command line interface for submissions to [AutolabJS](https://github.com/AutolabJS/AutolabJS). + + + +## Commands ## +* `autolab init` - Initializes local repository and authenticates +* `autolab exit` - Wipes off the credentials from the system +* `autolab git create` - Creates a repository on Gitlab +* `autolab git delete` - Deletes the specified repository from Gitlab +* `autolab git changeserver` - To change the host of the gitlab server +* `autolab git changelang` - To change the language of the code submission +* `autolab git push` - Adds, commits, pushes the code +* `autolab submit` - To submit the code to JavaAutolab and fetch the results +* `autolab exit` - Print help manual + + +## Installation ## +``` +npm install -g autolabcli +``` + +## Screenshot ## + + +## License ## +GNU General Public License diff --git a/docs/Product-Features.md b/docs/Product-Features.md new file mode 100644 index 0000000..e85487b --- /dev/null +++ b/docs/Product-Features.md @@ -0,0 +1,25 @@ +A summary of project features are: + +1. Auto-evaluation support for programming labs. +1. Support for multiple languages. The languages supported are: C, C++, Java, Python. +1. Automated score board listing maximum marks for each of students. +1. Uses Gitlab to provide *git* version control to students. +1. Uses Docker containers to separate the Autolab components. +1. Support for unit / integration / functional and Input-Output testing strategies. +1. Ansible-based auto configuration and installation procedure. +1. <s>On demand auto re-evaluation for instructors.</s> (this feature needs bug fixing) + + +Screenshots +----------- +A few screenshots of the project. + +### Main page ### + + +### Evaluation Request ### +![Evaluation Request] (images/evaluation_request.png) + +### Scoreboard ### + + diff --git a/docs/autolabcli.md b/docs/autolabcli.md index 31f1e98..f278d21 100644 --- a/docs/autolabcli.md +++ b/docs/autolabcli.md @@ -1 +1 @@ -* [AutolabCLI](https://github.com/AutolabJS/autolabcli) +Link to AutolabCLI - [AutolabCLI](https://github.com/AutolabJS/autolabcli) diff --git a/mkdocs.yml b/mkdocs.yml index ed3cfb1..ab943c5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,9 +46,13 @@ pages: - Input-Output (IO) tests using : - Source code : 'AutolabJS v0.2.0/v0.2.0-IO-Tests.md' - Compiled binaries : 'AutolabJS v0.2.0/v0.2.0-IO-Tests-Binaries.md' - - Post lab self evaluation : 'AutolabJS v0.2.0/v0.2.0-Post-lab-self-evaluation.md' - - AutloabJS Coding Standards : 'AutolabJS-coding-standards.md' - - AutolabCLI: 'autolabcli.md' + - Post lab self evaluation : 'AutolabJS v0.2.0/v0.2.0-Post-lab-self-evaluation.md' + - Product Features : 'Product-Features.md' + + - Coding Standards : 'AutolabJS-coding-standards.md' + - AutolabCLI: + - Home : 'autolabcli.md' + - Student Tutorial : 'Autolabclireadme.md' - Documentation: 'docs.md' - AutolabWebsite: 'website.md' extra: