Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Muaath5 committed Sep 8, 2024
1 parent 93b6444 commit 7c06623
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 20 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
.ruby-version
__pycache__
.jekyll-cache
__pycache__
_site
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
# Saudi Informatics Team Website
This website is made by the students on the Saudi Team, to preserve history of Saudi Informatics Team (SIT) in one place.

## Usage
1. Edit `/root/data/*.json` files, and keep them updated
2. Commit to the repository
This website includes: olympiads, participations, members, contact, and image library.

## How does it work?
It's 100% automated using `build.py` and Github workflows
## Documentation
Read [Website public data files](https://sainformatics.org/data/) documentation.

## Local Build
```sh
python build.py
jekyll serve -s ./root
```

## Maintainers
This website needs people who maintain the data up-to-date.

The main goal is to have at any time **at least 3 active maintainers**.

Current maintainers:

## Developers
- Muaath Alqarni
- Ali Alsalman
- Ali Alsalman

## License
Selected soon...
8 changes: 1 addition & 7 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,4 @@
- [ ] Add a calendar, with these properties
- Could be displayed as (list, month, year)
- Could be imported to Google or Apple Calendar
- Auto updated by the JSON files

## Routines
- Keep minimum of 3 maintainers
- Add photos/data after each olympiad/camp
- Keep participations up-to-date
- Add the new students to the database
- Auto updated by the JSON files
3 changes: 0 additions & 3 deletions build.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,6 @@ def build_participations_index():

write_file("en/participations/index.html", written)

# Generate a medals count list only in official olympiads
# Sort it by gold/silver/bronze/hm
# Print the list in a table
def build_hall_of_fame():
official_olympiads = []
for oly in olympiads_j:
Expand Down
2 changes: 2 additions & 0 deletions root/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
plugins:
- jekyll-seo-tag
2 changes: 0 additions & 2 deletions root/_layouts/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">


<link rel="stylesheet" href="/assets/css/extended.css">

<!-- Bootstrap + Icon -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css">
{% if page.lang == "en" %}
Expand Down

0 comments on commit 7c06623

Please sign in to comment.