Skip to content

Commit c3fb27e

Browse files
committed
expand README and add codemeta.yaml
1 parent 090bd94 commit c3fb27e

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
11
# opensource.twitter.dev
22

3-
Home of opensource.twitter.dev
3+
This is the Twitter Open Source website at https://opensource.twitter.dev.
4+
5+
This site is built with [hugo], using a custom built-in theme. Follow the
6+
standard instructions on the hugo website to [install] and [run] hugo. Just
7+
make sure to use hugo-extended, which has added support for Sass/SCSS
8+
stylesheets.
9+
10+
There are also some python scripts that run periodically to [update some repo
11+
data].
12+
13+
[hugo]: https://gohugo.io/
14+
[install]: https://gohugo.io/getting-started/installing/
15+
[run]: https://gohugo.io/getting-started/usage/
16+
[update some repo data]: ./.github/workflows/update-data.yml

codemeta.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
"@context": https://doi.org/10.5063/schema/codemeta-2.0
3+
"@type": SoftwareSourceCode
4+
license: https://spdx.org/licenses/Apache-2.0
5+
codeRepository: git+https://github.com/twitter/opensource-website.git
6+
issueTracker: https://github.com/twitter/opensource-website/issues
7+
name: opensource.twitter.dev
8+
developmentStatus: active
9+
author:
10+
- "@type": Organization
11+
identifier: OSS
12+
name: Twitter Open Source Programs Office

0 commit comments

Comments
 (0)