Skip to content

Commit e3ca3e1

Browse files
authored
README conversion and translation instruction update (#640)
Convert README to Markdown, and updates translation instructions.
1 parent 30d345c commit e3ca3e1

File tree

2 files changed

+74
-108
lines changed

2 files changed

+74
-108
lines changed

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<a href="https://beeware.org"><img src="http://beeware.org/static/images/brutus-270.png" width="72px" alt="Brutus the Bee"></a>
2+
3+
# beeware.github.io
4+
5+
This is the homepage for the [BeeWare project](http://beeware.org).
6+
7+
It is a [Lektor](https://getlektor.com)-based site.
8+
9+
If you want to contribute a modification, you can fork this repository
10+
and submit a pull request. However, **do not fork the main branch** -
11+
fork the [lektor branch](https://github.com/beeware/beeware.github.io/tree/lektor) and make changes there instead.
12+
13+
If you want to test out a change before you submit it, create a virtual
14+
environment, and install [Lektor](https://getlektor.com):
15+
16+
```
17+
$ python3 -m venv venv
18+
$ source venv/bin/activate
19+
(venv) $ python -m pip install lektor
20+
```
21+
22+
Then from the root directory of the checkout, run:
23+
24+
```
25+
(venv) $ lektor server
26+
```
27+
28+
This will [start a webserver](http://127.0.0.1:5000) that will
29+
autoreload whenever you make a change to site content.
30+
31+
## Community
32+
33+
You can talk to the community through:
34+
35+
- [@beeware@fosstodon.org on Mastodon](https://fosstodon.org/@beeware)
36+
- BeeWare Discord server: [Discord](https://beeware.org/bee/chat/)
37+
- [Tickets on the beeware.github.io issue tracker](https://github.com/beeware/beeware.github.io/issues)
38+
39+
## Contributing
40+
41+
If you find problems with this website, [log them on GitHub](https://github.com/beeware/beeware.github.io/issues). If you want to contribute, please [fork the code](https://github.com/beeware/beeware.github.io/tree/lektor) and [submit a pull request](https://github.com/beeware/beeware.github.io/pulls).
42+
43+
Before submitting a pull request, please make sure your forked branch is
44+
up-to-date with the original branch. To do this:
45+
46+
- Set your upstream remote:
47+
48+
```
49+
$ git remote add upstream https://github.com/beeware/beeware.github.io.git
50+
```
51+
52+
- Make sure you have the latest changes from upstream:
53+
54+
```
55+
$ git fetch upstream
56+
```
57+
58+
- Rebase your `lektor` branch to `upstream` before pushing to git
59+
and submitting a pull request:
60+
61+
```
62+
$ git rebase upstream/lektor
63+
```
64+
65+
## Translations
66+
67+
<a href="https://hosted.weblate.org/projects/beeware/website/"><img src="https://hosted.weblate.org/widget/beeware/website/open-graph.png" width="300px" alt="Website translation status"></a>
68+
69+
We manage translations using [Weblate](https://weblate.org/).
70+
71+
<a href="https://hosted.weblate.org/engage/beeware/"><img src="https://hosted.weblate.org/widget/beeware/website/horizontal-auto.svg" alt="Translation status" /></a>
72+
73+
If you'd like to contribute to the translation effort, join the `#translations`
74+
channel on [Discord](https://beeware.org/bee/chat/) and introduce yourself!

README.rst

Lines changed: 0 additions & 108 deletions
This file was deleted.

0 commit comments

Comments
 (0)