Skip to content

Enhanced README: Clearer Description, Exciting Features, and Contribution Guidance #126

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

Open
kberon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhanced README: Clearer Description, Exciting Features, and Contribution Guidance #126

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
45 changes: 36 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,58 @@
# Cherry 🍒
With the vast number of courses on offer at UIUC and the wide variation in average GPA, instructor quality, prereqs, and number of GenEds fulfilled, picking the best course to take is hard.
Choosing the right courses at the University of Illinois Urbana-Champaign (UIUC) can be a daunting task, given the wide array of options with varying GPAs, instructors, prerequisites, and Gen-Ed fulfillments. Enter Cherry, your ultimate course selection companion. With Cherry, discovering the perfect courses has never been easier. Simply open Cherry to access a curated list of UIUC courses, sorted by GPA from highest to lowest. You can even search by department, class name, or fine-tune your choices based on Gen-Ed requirements like humanities and arts, advanced composition, and more. And that's just the beginning—stay tuned for more exciting features! 🚀

Cherry aims to solve this to make course picking super easy. Just open Cherry, and see a list of all the courses at UIUC sorted by highest to lowest GPA. You can search by departments and even filter courses based on Gen-Eds you'd like to fulfill, with tons of more planned features coming soon!
# Features
- GPA Sorting: Browse courses sorted from highest to lowest GPA, making it easier to find high-performing courses.
- Department Filters: Narrow down your choices by selecting specific departments.
- Gen-Ed Filters: Quickly identify courses that fulfill your Gen-Ed requirements.
- Active Development: Cherry is an open-source project actively developed by contributors in the Open-Source @ Illinois community. Be part of Cherry's growth by joining our Discord community!

🚀 Cherry is being actively developed by contributors in Open-Source @ Illinois. Be a part of cherry by joining our [Discord](https://discord.gg/sKYtc9QhuP)!
🚀 Cherry is being actively developed by contributors in Open-Source @ Illinois. Be a part of Cherry by joining our [Discord](https://discord.gg/sKYtc9QhuP)!

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/open-source-at-illinois/cherry/issues) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/sKYtc9QhuP) [![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/open-source-at-illinois/)

## Contributing

See [ONBOARDING.md](https://github.com/open-source-at-illinois/cherry/blob/main/ONBOARDING.md) for detailed guidelines on contributing to Cherry 🍒
Ready to make an impact? Check out our [ONBOARDING.md](https://github.com/open-source-at-illinois/cherry/blob/main/ONBOARDING.md) guide for detailed instructions on how you can start contributing to Cherry 🍒.

## Project Charter

### Vision

To help UIUC students plan and schedule their courses according to their varied needs better
To help UIUC students plan and schedule their courses according to their unique needs better.

### Mission

To create a tool to help students select classes
To create a tool to help students select classes.

### Success Criteria

1. Is it better than the current alternatives?
2. Are we using it to select our own courses?
3. Are a majority of users are consistently using cherry?
1. Is Cherry the preferred choice among UIUC students for course selection?
2. Do UIUC students actively use Cherry for course planning?
3. Is Cherry regarded as a superior alternative to existing course selection tools?

## 🙏 Credits and Acknowledgments

Cherry wouldn't be possible without the support and contributions of the following individuals and organizations:

- [Open-Source @ Illinois](https://opensource.illinois.edu/): Our community of passionate developers who actively collaborate on Cherry's development.

## 💡 How to Use Cherry

Cherry simplifies the course selection process at UIUC by offering the following features:

- **Filter by Gen-Eds:** On the Cherry website, you can filter courses based on Gen-Ed topics like humanities and arts, advanced composition, and more.
- **Search by Class Name:** Looking for a specific class? Simply use the search bar to find it.
- **Course Listings:** Cherry provides a list of courses that match your filters, along with essential details, including GPA information.

To use Cherry effectively:

1. Visit the ([Cherry Website](https://cherry.opensourceatillinois.com/home)).
2. Use the Gen-Ed filters to narrow down your course options or utilize the search feature to find a specific class.
3. Browse the list of courses, and click on the provided links for more details.
4. Make informed course selections based on GPA data and other relevant information.

We hope Cherry simplifies your course selection process and helps you make the best choices for your academic journey! 🍒

<!--

Expand Down