Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #38

Merged
merged 1 commit into from
Oct 22, 2023
Merged

Update README.md #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 2 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ This project facilitates efficient item allocation to students based on specifie
6. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation-1)
7. [Contributing](#contributing)
8. [License](#license)
9. [Acknowledgments](#acknowledgments)


## Introduction

Expand All @@ -49,7 +47,7 @@ Provide a brief introduction to the project, its goals, and the problems it solv

### Functions

1. **createGraph()**: Builds a directed graph based on provided items, creating edges between items with suitable time gaps.
1. ** ()**: Builds a directed graph based on provided items, creating edges between items with suitable time gaps.
2. **buildGroupsWithSamePaths()**:Finds every Poll Combination and returns groups
3. **findPathsForEachGroup()**: Finds every possible Path for each group
4. **allocateGroupsToItems()**: Allocates the groups to the items.
Expand Down Expand Up @@ -95,13 +93,6 @@ To start the project, use:
npm start
```

## Notes

- Mention any assumptions, key strategies, and efficiency considerations.
- Highlight any customization options or parameters that users might want to adjust.

## Getting Started

### Prerequisites

List any prerequisites or dependencies that users need to have installed.
Expand All @@ -110,14 +101,4 @@ List any prerequisites or dependencies that users need to have installed.

Provide step-by-step instructions on how to install and set up the project.

## Contributing

Outline guidelines for contributing to the project. Include information on how to submit issues, suggest improvements, and propose new features.

## License

Only personal use.

## Acknowledgments

Give credit to any third-party libraries, resources, or inspirations used in the project.
Loading