Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
calvinchai committed Feb 9, 2024
1 parent bca822a commit dd32a32
Showing 1 changed file with 4 additions and 48 deletions.
52 changes: 4 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ docker run -d --name magi -p 8501:8501 -v ./settings:/app/settings ghcr.io/cics-
version: '3'
services:
magi:
name: magi
image: ghcr.io/cics-syslab/magi:latest
volume:
- ${pwd}/settings:/app/settings
Expand All @@ -49,63 +50,18 @@ If you prefer to build the application from source, follow the instructions in t
## Usage
Access the web interface through http://host:port
<!-- Start the gui
```bash

```

The interface is organized into tabs, with two default tabs: Preview and Basic Settings. When you enable different modules or plugins, their respective settings (if available) will appear in newly created tabs.

### Basic Settings

This page includes the generic information about the assignment and overall settings. The attributes are listed below,

- Project Name:
The title for the project and also the name shown on the generated material such as the documentation.

- Project Desc:
Optional. A paragraph long brief description for the project. Could be a scenario or something related.

- Submission Files:
A list of file required for submission. In case of the student's submission doesn't include one or more files in the list, the autograder will not run or produce the test result but throws an error message to notify the student.

- Enabled Module:
Choose the module you wish to use. Please note that modules are mutually exclusive, allowing only one module to be enabled at a time.

List of modules currently available:
- [Network Project Engine](https://github.com/nightdawnex/gsgen/tree/main/modules/NetworkProjectEngine)

<!-- - [Thread Project Engine](https://github.com/nightdawnex/gsgen/tree/main/modules/ThreadingProjectEngine) -->

<!-- - Enabled Plugins:
Select the plugins you want to use. You can enable multiple plugins simultaneously.
List of Plugins currently available: -->

<!-- ### Preview
On the preview page, you can choose where to generate the output project files.
The files will be generated in a folder named after the project. If the folder already exists, it will be appended with the current time. -->

### Upload the autograder to Gradescope

In gradescope, select Ubuntu-22.04 as base image and upload the generated zip file.

<!-- For more detailed usage instructions, please refer to the [User Guide](link-to-user-guide.md). -->
<!-- ---
For detailed usage instructions, please refer to the [Usage page](https://github.com/cics-syslab/MAGI/wiki/Usage).
## Contributing
We welcome contributions! Please check out our [CONTRIBUTING.md](link-to-contributing-guide.md) for guidelines. -->
We welcome contributions! Please check out our [Contributing page](https://github.com/cics-syslab/MAGI/wiki/Contributing) for guidelines.
---
## Support & Feedback
For support or to provide feedback, please raise an issue on our [GitHub repository](https://github.com/cics-syslab/MAGI).
For support or to provide feedback, please raise an issue on our [GitHub repository](https://github.com/cics-syslab/MAGI/issues).
---
Expand Down

0 comments on commit dd32a32

Please sign in to comment.