Skip to content

Commit

Permalink
chore(docs): update readme, license for fork
Browse files Browse the repository at this point in the history
  • Loading branch information
pooh-bear committed May 26, 2024
1 parent dde0a1e commit 9172919
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017 qconrad
Copyright (c) 2017 qconrad, pooh-bear

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# intellistar-emulator
A web application that displays weather information in the same visual presentation as the cable headend unit [Intellistar](https://en.wikipedia.org/wiki/IntelliStar).
A web application that displays weather information in the same visual presentation as the cable headend unit [Intellistar](https://en.wikipedia.org/wiki/IntelliStar).

Forked from [qconrad's incredible effort](https://github.com/qconrad/intellistar-emulator) to serve as a more frequently updated, bleeding edge version of this project. (See Contributing.)

## Overview
This is a local forecast segment that airs on The Weather Channel called the "Local on the 8s". The name is because it airs at timeslots that end in "8" (9:28, 2:48, etc.). The forecast is approximately a minute long and provides information on current and forecasted weather conditions. This type of forecast started in 1982 using WeatherStar units. It was later upgraded to Intellistar in 2003 and received various graphic changes over the years. This emulator uses the style that started in 2013.

## Instructions
## Option 1 (easier)
1. Visit: <https://qconrad.github.io/intellistar-emulator/>.
1. Visit: <https://pooh-bear.github.io/intellistar-emulator/>.
2. Enter zip code
3. Click start
4. Press F11 for fullscreen
Expand All @@ -19,7 +21,7 @@ This is a local forecast segment that airs on The Weather Channel called the "Lo
5. Press F11 for fullscreen

## Option 3 (Docker)
1. `docker run -p 8080:80 ghcr.io/qconrad/intellistar-emulator`
1. `docker run -p 8080:80 ghcr.io/pooh-bear/intellistar-emulator`
2. Visit: http://localhost:8080
3. Enter zip code
4. Click start
Expand All @@ -33,7 +35,12 @@ Most of core animation and logic has been replicated including severe weather al
## Looping
To enable or disable looping, click on the TWC logo in the info-bar in the top-left corner of the emulator.

To get looping working properly, you may (as of Chrome M66) have to go to chrome://flags#autoplay-policy (Autoplay Policy) and change it to `User gesture is required for cross-origin iframes` or `No user gesture is required`
## Contributing
Whilst I pay massive respects to all [the previous contributors](https://github.com/qconrad/intellistar-emulator/graphs/contributors) of this project, things seem to be breaking faster than contributors' activeness with the project/on Github. I also think there's a lot of potential yet to be baked into this! Through this fork, I'll be adding in what I think are important fixes and features (major, QOL, or otherwise) that may not be in the target vision of the original contributors.

I endeavor to push as much, if not all, contributions, upstream, however, this forks serve to be a more "active" repo, as I am actively working on other projects/repos on Github as a full time software engineer.

So please feel free to contribute if you'd like to! All are welcome, no matter if it's your first or thousandth time that you're contributing to Open Source Software. Please create a PR and tag me (@pooh-bear) for review! I endeavor to initially glace/comment through on all PRs I receive within 24-48 hours, and approve/merge all good-standing PRs expediciously.

## Screenshots
![Screenshot 1](/screenshots/1.png)
Expand Down

0 comments on commit 9172919

Please sign in to comment.