From 46dc5d2aa1c24593217b599eeb3983a53918d9aa Mon Sep 17 00:00:00 2001
From: Michael Tu <32557414+mtu4172@users.noreply.github.com>
Date: Sun, 1 Oct 2023 20:34:21 -0400
Subject: [PATCH 1/3] Update README.md
---
README.md | 31 +++++++++++++++++++++++++------
1 file changed, 25 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 7ee27cd..f601532 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,39 @@
# AskAGator
+### _Have a question about a UF CS class? AskAGator is an app that connects students with professors and peers for all your class needs, including class content, logistics, and more! Powered by Elixir+Phoenix._
+---
-To start your Phoenix server:
+## Get Started
- * Install dependencies with `mix deps.get`
- * Create and migrate your database with `mix ecto.setup`
- * Install Node.js dependencies with `cd assets && npm install`
- * Start Phoenix endpoint with `mix phx.server`
+To start, clone the repository: `git clone https://github.com/ufosc/AskAGator`
+
+Navigate to the project directory: `cd AskAGator`
+
+To run your Phoenix app:
+* Make sure you have [Elixir](https://elixir-lang.org/install.html) installed.
+* Install dependencies with `mix deps.get`
+* Create and migrate your database with `mix ecto.setup`
+* Install Node.js dependencies with `cd assets && npm install`
+* Start Phoenix endpoint with `mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
-## Learn more
+### Learn more
* Official website: http://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html
* Docs: https://hexdocs.pm/phoenix
* Mailing list: http://groups.google.com/group/phoenix-talk
* Source: https://github.com/phoenixframework/phoenix
+
+## Contributing
+- All contributions are welcome and appreciated!!
+ - Language: [Elixir](https://elixir-lang.org/docs.html)
+ - Framework: [Phoenix](https://hexdocs.pm/phoenix/Phoenix.html)
+ - Database: [Postgres](https://www.postgresql.org/docs/)
+
+## Thank you to our contributors!
+
+ 
+
From fc8b47172680c537b2ef6c73a5be817e08e06cdb Mon Sep 17 00:00:00 2001
From: Michael Tu <32557414+mtu4172@users.noreply.github.com>
Date: Sun, 1 Oct 2023 20:35:56 -0400
Subject: [PATCH 2/3] Create LICENSE
---
LICENSE | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
create mode 100644 LICENSE
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c2389b2
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Open Source Club
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
From 9377ccb3a7f82362dfee807382ad39e341835b79 Mon Sep 17 00:00:00 2001
From: Michael Tu <32557414+mtu4172@users.noreply.github.com>
Date: Sun, 1 Oct 2023 20:38:32 -0400
Subject: [PATCH 3/3] Add License to README.md
---
README.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/README.md b/README.md
index f601532..88c796d 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,8 @@ Ready to run in production? Please [check our deployment guides](https://hexdocs
- Framework: [Phoenix](https://hexdocs.pm/phoenix/Phoenix.html)
- Database: [Postgres](https://www.postgresql.org/docs/)
+ [](https://opensource.org/licenses/MIT)
+
## Thank you to our contributors!