Updated README.md (#3)

README.md

@@ -1,4 +1,4 @@
-# Your ACM Project Title Here!
+# ACM W Website!
 
 ![Production Build](https://github.com/uclaacm/w-website-new/workflows/Production%20Build/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -22,42 +22,12 @@ Here's what it does:
 
 ## Overview
 
-Hello! This website is built by the ACM dev team with Next.js on top of React and deployed on Netlify. Under the hood, we use both ESLint and Stylelint to lint our JS and CSS code respectively.
-
-## Things You Should Do (and then delete this section)
-
-Thanks for using our template! We hope this makes your life developing significantly easier.
-
-Things you should do **after using this as a template**:
-
-- [ ] find-and-replace `YOUR_PROJECT_URL_HERE` with your GitHub repo's project name in this README (it's in a few places, so use an editor!)
-- [ ] add to the Overview section above with any desired information about what your website is for.
-- [ ] ~~set up [Netlify](https://www.netlify.com/) for this app - talk to the current dev team director: arsh (`@ArshMalik02`) if you need access to the ACM UCLA Netlify team.~~
-- [ ] ~~turn on "Automatically delete head branches" in GitHub `Settings > Options`~~
-- [ ] ~~in `Settings > Branches`, create a branch protection rule for `main` that requires PR reviews. Also require status checks, like passing `build`.~~
-- [ ] ~~_only_ enable squash merging in Github `Settings > Options > Merge Button` (and disable merge commits and rebase merging).~~
-- [ ] this is a reminder to periodically run accessibility checks & Search Engine Optimization on your project by running `inspect element / developer tools > Lighthouse`
-- [ ] ~~update the README badges for the GitHub Actions and Netlify with the correct links!~~
-- [ ] update and delete this documentation!
-- [ ] update `public/index.html` to have a description and title
-- [ ] update `public/favicon.svg` as needed
-
-## ~~Loading in Committee Info (can also delete this section when done)~~
-
-~~Thanks for using our template for your committee's website!~~
-
-To build the site with your committee-specific information, you will fill out two fields in the `global_variables.module.scss` file, which can be found in the styles folder. (full path: `./styles/global_variables.module.scss`)
-
-Next to `$committee-color`, please replace the sample color with the hex code of your committee's color, which will be the accent color for the overall site.
-
-Next to `$committee`, please replace the sample text with your committee's name, spelled and capitalized properly, exactly how it appears on the Committee Info spreadsheet. (example: TeachLA, ICPC, W are all valid. teach la, Icpc, w are invalid.) We will be using this to properly scrape your committee's information, so it is super important that this variable is correctly set! Please contact Elizabeth Kim (`@elizabethkim11`) if you would like your committee's name to be reflected differently than how it appears on the spreadsheet.
-
-You will also fill out another field for your committee name in the `global-variables.js` file, which is located in the scripts folder. (full path: `./scripts/global-variables.js`) Replace the sample committee name in the string on line 1 with your committee's name. Please follow the same guidelines as above for the committee name input.
+Hello! Thank you checking out the new git repository for the ACM-W website! If you want to be involved or learn more, please feel to reach out to us at: [email protected]
 
 ## Spreadsheet Image Guidelines
 
 - All image links should be sharable google drive links, with access permissions set to "Anyone with the link."
-- All images should be `.png` or `.jpg` files.
+- All images should be .png or .jpg files.
 - All headshots must be square cropped.
 - Contact Elizabeth Kim (`@elizabethkim11`) to properly modify your design assets to suit the template's home page.
 
@@ -67,8 +37,8 @@ We'll use a really common Node.js project workflow + Yarn!
 First, let's clone our repository, and install all of our yarn dependencies:
 
 ```
-git clone https://github.com/uclaacm/YOUR_PROJECT_URL_HERE.git
-cd YOUR_PROJECT_URL_HERE
+git clone https://github.com/uclaacm/w-website-new.git
+cd w-website-new
 ```
 
 The instructions to install Node.js will be different based on which platform you're running. It's heavily advised to install your Node.js using NVM (Node Version Manager) because it's easy to manage a standardized version and update it as needed.
@@ -83,10 +53,6 @@ At this point you can run `nvm install`. Assuming you've already `cd`ed into the
 
 If you're on Windows, you can use NVM for Windows, a separate version manager whose installation instructions can be found [here](https://github.com/coreybutler/nvm-windows#installation--upgrades). Once you've done that, you can run `nvm install 16.13.2` to install the LTS version of Node.js, and `nvm use 16.13.2` to switch to it.
 
----
-
-Once you have the correct Node version in use, check that you have yarn installed by running `yarn --version`.
-
 If you don't have yarn installed...
 
 ```
@@ -103,21 +69,21 @@ yarn prepare
 (If the above commands don't work even after installing yarn via npm, check this [npm installation guide](https://classic.yarnpkg.com/en/docs/install/#mac-stable), click on alternatives, choose your operating system, and follow the steps there!)
 
 (We handle the yarn and npm conflict issues within our `.gitignore` we set up so dw about it!)
+To start our app, you just need to run `yarn start`!
 
-Once you have the dependencies installed, create a `.env.local` file in the root directory similar to the `.env.example` file. This will be used to store any environment variables that you want to keep secret. Please contact the dev team director `@ArshMalik02` or one of the lead devs `@elizabethkim11` for the correct environment variables to use.
-
-To start our app in development mode, run `yarn dev`!
+```
+yarn start
+```
 
-To build our project for production (with CRA and Webpack's bundling with all that goodness), run
+And to build our project for production (with CRA and Webpack's bundling with all that goodness),
 
 ```
 yarn run build
-yarn start
 ```
 
 ## Contribution Workflow
 
-Thanks for your interest in contributing to YOUR_PROJECT_URL_HERE! ❤️
+Thanks for your interest in contributing to w-website-new! ❤️
 
 Here's a quick guide on how to get started.
 
@@ -126,7 +92,7 @@ Here's a quick guide on how to get started.
 3. Beep boop away!
 4. **Before you push**, make sure your app runs with `yarn start`. If there are any errors, our CI/CD service will **reject your build**.
 5. Once you're ready, stage and commit your changes!
-6. Make a [pull request](https://github.com/uclaacm/YOUR_PROJECT_URL_HERE/pulls) with your changes, and let someone on your project team know.
+6. Make a [pull request](https://github.com/uclaacm/w-website-new/pulls) with your changes, and let someone on your project team know.
    a. Netlify has a neat feature called "Deploy Previews" that give you a link to preview your changes; [see the blog post](https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/) for more info!
 7. If your code passes code review, then we can **squash and merge** it into `main`. Congratulations! If you'd like, it's now safe to delete your branch/fork.
 
@@ -232,4 +198,4 @@ Take a look at `<YOUR_PROJECT_PATH>/asset-manifest.json`. [Like this!](https://t
 
 ## Licensing & Attribution
 
-This project and its code are licensed under the MIT License. You're free to use them however you wish, though we'd love to hear from you if you found this useful!
+This project and its code are licensed under the MIT License. You're free to use them however you wish, though we'd love to hear from you if you found this useful!