Merge pull request #27 from code-IM-perfect/main

Updated secys and cordies for 2024-25

Gemfile

@@ -6,3 +6,4 @@ gem "jekyll-paginate"
 gem 'jekyll-tagging'
 gem "jekyll-sitemap"
 gem "webrick", "~> 1.7"
+gem "json"

Gemfile.lock

@@ -40,6 +40,7 @@ GEM
       nuggets
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    json (2.7.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -53,7 +54,6 @@ GEM
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (5.0.3)
-    rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -62,7 +62,6 @@ GEM
     safe_yaml (1.0.5)
     sass-embedded (1.64.2)
       google-protobuf (~> 3.23)
-      rake (>= 13.0.0)
     sassc (2.1.0-x86_64-linux)
       ffi (~> 1.9)
     terminal-table (3.0.2)
@@ -79,6 +78,7 @@ DEPENDENCIES
   jekyll-paginate
   jekyll-sitemap
   jekyll-tagging
+  json
   sassc (~> 2.1.0)
   webrick (~> 1.7)
 

README.md

@@ -1,8 +1,22 @@
-# pclub-web-revamp
-Programming Club IIT Kanpur Website Revamp
+# Pclub Website
+Pclub's website is a jekyll based static pages website with a custom theme.
 
-### Deployment
+### Dependencies
+The only dependency is `jekyll`...which is made with `ruby` so it is and extended dependency. As with anything Ruby, it is recommended to use 
 
-To run the theme locally,clone and navigate to the theme directory and run `bundle install` to install the dependencies, then run `bundle exec jekyll serve` to start the Jekyll server. Check `http://127.0.0.1:4000/` now.
+### Running locally
+To run the theme locally
+- Install `ruby` along with `gem` which probably installs alongside (preferably with a package manager)
+- Install `bundle` with `gem install bundle`
+- Now clone this repo (fork it if you haven't) and navigate to the cloned directory
+- Run `bundle install` to install all the dependencies
+- Finally run `bundle exec jekyll serve` to start build the project and start a Jekyll server on localhost
+- You can use `bundle exec jekyll serve --livereload` instead to automatically preview the changes as you make them (auto reloads on file save)
+- You can preview the site at `localhost:4000` or `127.0.0.1:4000`
 
-I would recommend checking the [Official Documentation](https://jekyllrb.com/docs/) page on Jekyll website.
+It is recommended to check out the official [step-by-step tutorial](https://jekyllrb.com/docs/step-by-step/) which does an excellent job explaining the workings of Jekyll
+
+## Structure of the project
+The structure of this project is like any normal jekyll project, with an exception of the `updating-scripts` folder which contains custom scripts to make the task of updating the site every year easier and have nothing to do with the actual site served.
+
+The general structure of a jekyll project is comprihensively explained in [their docs](https://jekyllrb.com/docs/structure/)