Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ENHANCEMENT]- Updated README.md #174

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[ENHANCEMENT]- Updated README.md #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
# opensource.twitter.dev
# Twitter Open Source

[![status: active](https://opensource.twitter.dev/status/active.svg)](https://opensource.twitter.dev/status/#active)

This is the Twitter Open Source website at https://opensource.twitter.dev.
Twitter Open Source is a website that hosts open source projects developed by Twitter. The website is available at https://opensource.twitter.dev and is actively maintained.

This site is built with [hugo], using a custom built-in theme. Follow the
standard instructions on the hugo website to [install] and [run] hugo. Just
make sure to use hugo-extended, which has added support for Sass/SCSS
stylesheets.
## Technologies Used

There are also some python scripts that run periodically to [update some repo
data].
The website is built using Hugo, a static site generator. It uses a custom built-in theme that is designed to match the Twitter brand. To run the website locally, follow the standard instructions provided on the Hugo website. Make sure to use the Hugo extended version, as it has added support for Sass/SCSS stylesheets.

## Repo Data Update

Periodically, some Python scripts run to update data related to the repositories hosted on Twitter Open Source. These scripts help keep the website up to date and provide the latest information to users

[hugo]: https://gohugo.io/
[install]: https://gohugo.io/getting-started/installing/
[run]: https://gohugo.io/getting-started/usage/
[update some repo data]: ./.github/workflows/update-data.yml

## Contributing
Twitter Open Source is an open-source project, and contributions from the community are welcome. If you want to contribute to the project, please read the contributing guidelines and follow the instructions provided.