Skip to content

Commit 9738659

Browse files
committed
README cleanup
1 parent 463473b commit 9738659

File tree

1 file changed

+34
-35
lines changed

1 file changed

+34
-35
lines changed

README.md

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,24 @@
22

33
This repository contains the source for <https://tt-rss.github.io>.
44

5-
## License
6-
7-
### Documentation Content
8-
9-
The documentation and site content in this repository is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](LICENSE).
10-
11-
**You are free to:**
12-
- Share and redistribute the documentation
13-
- Adapt and build upon the documentation
14-
15-
**Under these terms:**
16-
- **Attribution** — Give appropriate credit and link to the license
17-
- **ShareAlike** — Distribute adaptations under the same CC BY-SA 4.0 license
18-
19-
### Tiny Tiny RSS
20-
21-
The tt-rss software itself is licensed under the [GNU General Public License v3.0 (GPLv3)](https://github.com/tt-rss/tt-rss/blob/master/COPYING).
22-
23-
Any code snippets or configuration examples derived from tt-rss retain their original GPLv3 license.
24-
255
## Contributing
266

277
Contributions to improve the documentation are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
288

29-
By contributing, you agree that your contributions will be licensed under CC BY-SA 4.0.
9+
By contributing, you agree that your contributions will be licensed under CC BY-SA 4.0 (see [License](#license) below).
10+
11+
## Structure
12+
13+
```text
14+
tt-rss.github.io/
15+
├── _config.yml # Jekyll configuration
16+
├── index.md # Homepage
17+
├── docs/ # Documentation pages
18+
├── images/ # Screenshots and images
19+
├── LICENSE # CC BY-SA 4.0 license
20+
├── CONTRIBUTING.md # Contribution guidelines
21+
└── README.md # This file
22+
```
3023

3124
## Building Locally
3225

@@ -42,24 +35,30 @@ bundle exec jekyll serve
4235
# View at http://localhost:4000
4336
```
4437

45-
## Structure
46-
47-
```text
48-
tt-rss.github.io/
49-
├── _config.yml # Jekyll configuration
50-
├── index.md # Homepage
51-
├── docs/ # Documentation pages
52-
├── images/ # Screenshots and images
53-
├── LICENSE # CC BY-SA 4.0 license
54-
├── CONTRIBUTING.md # Contribution guidelines
55-
└── README.md # This file
56-
```
57-
58-
## Use Links
38+
## Useful Links
5939

6040
- **Documentation Repository:** [https://github.com/tt-rss/tt-rss.github.io](https://github.com/tt-rss/tt-rss.github.io)
6141
- **Documentation Site:** [https://tt-rss.github.io](https://tt-rss.github.io)
6242
- **Main Repository:** [https://github.com/tt-rss/tt-rss](https://github.com/tt-rss/tt-rss)
6343
- **Discussions:** [https://github.com/tt-rss/tt-rss/discussions](https://github.com/tt-rss/tt-rss/discussions)
6444
- **Issues:** [https://github.com/tt-rss/tt-rss/issues](https://github.com/tt-rss/tt-rss/issues)
6545

46+
## License
47+
48+
### Documentation Content
49+
50+
The documentation and site content in this repository is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](LICENSE).
51+
52+
**You are free to:**
53+
- Share and redistribute the documentation
54+
- Adapt and build upon the documentation
55+
56+
**Under these terms:**
57+
- **Attribution** — Give appropriate credit and link to the license
58+
- **ShareAlike** — Distribute adaptations under the same CC BY-SA 4.0 license
59+
60+
### Tiny Tiny RSS
61+
62+
The tt-rss software itself is licensed under the [GNU General Public License v3.0 (GPLv3)](https://github.com/tt-rss/tt-rss/blob/master/COPYING).
63+
64+
Any code snippets or configuration examples derived from tt-rss retain their original GPLv3 license.

0 commit comments

Comments
 (0)