Skip to content

add some explicit information to the README.md #182

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add some explicit information to the README.md #182

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e5f499
add some explicit information to the README.md
Saytzeff-D Jul 13, 2023
3309b70
badges and some texts were added to the README.md file
Saytzeff-D Jul 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,36 @@
# opensource.twitter.dev
# opensource.twitter.dev(Repo: `opensource-website`)

[![status: active](https://opensource.twitter.dev/status/active.svg)](https://opensource.twitter.dev/status/#active)
<h4 align="start">Learn . Think . Share about your OpenSource Development Journey</h4>
<p align="start">
<a href="https://opensource.twitter.dev/status/#active">
<img src="https://opensource.twitter.dev/status/active.svg" />
</a>
<a href="https://github.com/twitter/opensource-website/blob/master/LICENSE" target="blank">
<img src="https://img.shields.io/github/license/twitter/opensource-website?style=flat-square" alt="react-play licence" />
</a>
<a href="https://github.com/twitter/opensource-website/fork" target="blank">
<img src="https://img.shields.io/github/forks/twitter/opensource-website?style=flat-square" alt="react-play forks"/>
</a>
<a href="https://github.com/twitter/opensource-website/stargazers" target="blank">
<img src="https://img.shields.io/github/stars/twitter/opensource-website?style=flat-square" alt="react-play stars"/>
</a>
<a href="https://github.com/twitter/opensource-website/issues" target="blank">
<img src="https://img.shields.io/github/issues/twitter/opensource-website?style=flat-square" alt="react-play issues"/>
</a>
<a href="https://github.com/twitter/opensource-website/pulls" target="blank">
<img src="https://img.shields.io/github/issues-pr/twitter/opensource-website?style=flat-square" alt="react-play pull-requests"/>
</a>

</p>
This is the Twitter Open Source website at https://opensource.twitter.dev.

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.

It contains few .html and .js file extensions alongside a Dockerfile that displays the content of the webpage

There are also some python scripts that run periodically to [update some repo
data].

Expand Down