Skip to content

Commit

Permalink
Various grammatical and copyediting changes (#147)
Browse files Browse the repository at this point in the history 
Co-authored-by: Ben Samples <hi@mynameisben.fyi>
  • Loading branch information
@btsamples
btsamples and Ben Samples committed Apr 29, 2023
1 parent f33ae90 commit 7c5e347
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 66 deletions.
28 changes: 13 additions & 15 deletions README
View file
Expand Up @@ -2,25 +2,25 @@

## Folder structure
- `configs` : contains the configurations needed to build the page templates via the **build** tool (during development and also distribution).
- `content` : This folder will be copied as-is to the website distribution (`dist`) during **build**. _Please make sure that everything included in this folder is expected to be publicily accessibile via kivy.org_
- `content` : This folder will be copied as-is to the website distribution (`dist`) during **build**. _Please make sure that everything included in this folder is expected to be publicly accessible via kivy.org._
- `templates` : All the HTML templates needed to build the Kivy website are here.
- `tools`: Contains `build.py`, which is needed in order to build the website.


## How it works the page generation via templates?
## How do we generate the page from templates?

The **build tool** (`tools/build.py`) uses the `config/config.json` file in order to know what and how pages should be built.
The **build tool** (`tools/build.py`) uses the `config/config.json` file in order to know which pages should be built and how to build them.

As you can see, in `config/config.json` there are multiple pages defined, and each page have its own `template` and an `env`.
Multiple pages are defined in `config/config.json`, and each page has its own `template` and `env`.

### Yeah, but in `templates/index.html`, there's a `[[ include "components/header.html" ]]` what that does mean? And how we should use the `env` ?
### But in `templates/index.html`, there's an `[[ include "components/header.html" ]]`. What that does mean? And how we should use `env`?

The **build tool** uses [Renoir](https://github.com/emmett-framework/renoir) under the hood as a templating engine, is easy, production-ready and have a quite complete [documentation](https://github.com/emmett-framework/renoir/blob/master/docs/quickstart.md).
The **build tool** uses [Renoir](https://github.com/emmett-framework/renoir) under the hood as a templating engine. Renoir is easy, production-ready and has quite complete [documentation](https://github.com/emmett-framework/renoir/blob/master/docs/quickstart.md).

`env` should contain all the variables that need to be accessed during the page generation.

As an example, with the following configuration:
```
```json
...
{
"template": "index.html",
Expand All @@ -31,23 +31,21 @@ As an example, with the following configuration:
...
```
And the following snippet in `index.html`
```
```html
<p>Hi, [[ =name ]]</p>
```

Will produce the following output, when the template has been built:

```
```html
<p>Hello, Kivy</p>
```

## And how about the styling (CSS)?

Writing CSS code from scratch could be boring, stressful and sometimes a pain to mantain.
## How about the styling (CSS)?

[TailwindCSS](https://github.com/tailwindlabs/tailwindcss) fills this gap, marking itself as a utility-first CSS framework for rapidly building custom user interfaces.
Writing CSS code from scratch can be boring and stressful, and sometimes it is a pain to maintain.

Also TailwindCSS comes with an extensive documentation, and offers a lot of examples: [Getting Started with Tailwind CSS](https://tailwindcss.com/docs)
[TailwindCSS](https://github.com/tailwindlabs/tailwindcss) fills this gap, marking itself as a utility-first CSS framework for rapidly building custom user interfaces. It also comes with an extensive documentation and offers a lot of examples: [Getting Started with Tailwind CSS](https://tailwindcss.com/docs).

## Quick start:

Expand All @@ -70,7 +68,7 @@ Also TailwindCSS comes with an extensive documentation, and offers a lot of exam

### Development mode

Both **tailwindcss** and the **build tool** come with autoreload option, in order to speed-up the website development.
Both **tailwindcss** and the **build tool** come with auto-reload options in order to speed up site development.

```bash
npm run develop
Expand Down
19 changes: 9 additions & 10 deletions templates/about.html
View file
Expand Up @@ -13,13 +13,13 @@ <h1 class="text-4xl pb-5">
About us
</h1>
<p class="pb-5 font-light">
<b>Kivy</b> is a <b>community project</b>, led by professional software developers, who are responsible
for <b>developing</b> and <b>supporting</b> Kivy, <b>alongside of the community</b>. We also work for
<b>Kivy</b> is a <b>community project</b> led by professional software developers who are responsible
for <b>developing</b> and <b>supporting</b> Kivy <b>alongside of the community</b>. We also work for
companies that use <b>Kivy</b> for their <b>professional products</b>.<br><br>
<b>Many people</b> have <b>contributed</b> to Kivy and <b>we're always interested in growing our
community</b>. If you want to <b>help</b> in terms of <b>writing code, improving documentation,
testing</b>, etc. or simply <b>making a donation</b>, please do not hesitate to <a class="underline"
href="https://kivy.org/doc/stable/contact.html"><b>contact us</b></a>.
community</b>. If you want to <b>help</b> by doing things like <b>writing code, improving documentation or
testing</b>, or even if you simply want to <b>make a donation</b>, please do not hesitate to
<a class="underline" href="https://kivy.org/doc/stable/contact.html"><b>contact us</b></a>.
</p>
<div class="flex flex-wrap">
<div class="w-full my-3">
Expand Down Expand Up @@ -72,7 +72,7 @@ <h1 class="text-4xl pb-5">
[[ pass ]]
<div class="flex flex-wrap py-1 w-full">
<div class="w-full flex justify-end">
<p class="text-base">You made a talk but is not listed here?
<p class="text-base">You made a talk, but it's not listed here?
<span class="text-sm">
Feel free to <a class="underline"
href="http://www.github.com/kivy/kivy-website">open a PR</a>!
Expand All @@ -88,12 +88,11 @@ <h1 class="text-4xl pb-5">
</p>
<div class="flex flex-wrap">
<p class="font-light">
In order to encourage and give developers an opportunity to learn more about Kivy we
In order to encourage developers and give them an opportunity to learn more about Kivy, we
organized two contests in <a class="underline" href="contest-2012.html">2012</a> and <a
class="underline" href="contest-2014.html">2014</a>.<br>
With a total of 200+ partecipants along the two contests, we were able to improve the
quality of the documentation and the quality of the codebase, thanks to the partecipants
feedback.<br><br>
With a total of 200+ participants between the two contests, we were able to use their
feedback to improve the quality of the documentation and codebase.<br><br>
Is a new contest coming soon? Follow us on <a class="underline"
href="https://twitter.com/kivyframework">Twitter</a> to keep in touch!
</p>
Expand Down
45 changes: 22 additions & 23 deletions templates/contest-2012.html
View file
Expand Up @@ -38,9 +38,9 @@ <h2 class="font-lightbold text-lg mt-8">The winners are:</h2>
</li>
</ol>
<p class="font-light mt-5">
Congratulations for everyone who entered in the contest, and thanks a lot to our sponsors:
Congratulations to everyone who entered the contest, and thanks a lot to our sponsors
<a class="underline" href="http://www.notionink.com/">Notionink</a> and <a class="underline"
href="https://github.com/plans">Github</a>
href="https://github.com/plans">Github</a>.
</p>
<h2 class="font-lightbold mt-5 text-lg">Goals of the Contest</h2>
<ul class="font-light list-disc list-inside">
Expand Down Expand Up @@ -89,7 +89,7 @@ <h2 class="font-lightbold mt-5 text-lg">Prizes</h2>
<b>2nd Place</b>
<ul class="pl-3 list-disc list-inside">
<li> 1 <a href="http://www.notionink.com/techspecs.php">Notionink ADAM tablet (LCD Wifi)</a></li>
<li>One-year free <a href="https://github.com/plans">Github Bronze subscription</a></li>
<li>One year free <a href="https://github.com/plans">Github Bronze subscription</a></li>
<li>Github t-shirt</li>
<li>Kivy t-shirt</li>
</ul>
Expand Down Expand Up @@ -134,43 +134,42 @@ <h2 class="font-lightbold mt-5 text-lg">Rules</h2>
The participant must licence the game under an OSS licence.
</li>
<li>
The participant must submit the game developed using Kivy by uploading
it on Github provided space before the January 31, 2012, 23:59 GMT
Deadline. (Learn how to
<a href="http://help.github.com/set-up-git-redirect">Setup Git</a>,
<a href="http://help.github.com/create-a-repo/">Create a repository and add your code in
it</a>.
Don't wait till the last day of submission deadline for doing it!
The participant must submit the developed Kivy game by uploading
it to a Github provided space before the January 31, 2012, 23:59 GMT
deadline. (Learn how to
<a href="http://help.github.com/set-up-git-redirect">setup Git</a> and
<a href="http://help.github.com/create-a-repo/">create a repository for your code</a>.)
Don't wait until the deadline to do it!
</li>
<li>
The participant is allowed to use Kivy and standard python libraries.
Usage of pure python libraries are tolerated, if they are embed within
the application.
The participant is allowed to use Kivy and standard Python libraries.
Usage of pure Python libraries is tolerated, so long as they will
embed within the application.
</li>
<li>
The participant must respect the <a
href="http://kivy.org/docs/guide/quickstart.html#create-an-application">Application
layout</a> defined in Kivy documentation.<br />
The game must run on latest Kivy (1.0.9), with the command
href="http://kivy.org/docs/guide/quickstart.html#create-an-application">application
layout</a> defined in the Kivy documentation.<br />
The game must run on the latest Kivy (1.0.9) with the command
"<code>python main.py</code>"
</li>
<li>
Usage of externals libraries using ctypes, compiled extensions or
specific OS code are <u>forbidden</u>.
Use of external libraries via <code>ctypes</code>, compiled extensions, or
specific OS code is <u>forbidden</u>.
</li>
<li>
Usage of custom OpenGL is not allowed. Your application must be
compatible OpenGL ES 2.0.
Use of custom OpenGL is not allowed. Your application must be
compatible with OpenGL ES 2.0.
</li>
<li>
The game should be tested before hand. A failure to start will result in
The game should be tested beforehand. A failure to start will result in
negative points.
</li>
<li>
Any Adult or Offensive content is <u>forbidden</u>. The game should be kids friendly.
Any adult or offensive content is <u>forbidden</u>. The game should be for all ages.
</li>
<li>
Entries will be scored and prizes awarded by Panel of judges who are
Entries will be scored and prizes awarded by a panel of judges who are
excluded from participating.
</li>
</ol>
Expand Down
13 changes: 6 additions & 7 deletions templates/contest-2014.html
View file
Expand Up @@ -72,7 +72,7 @@ <h3 class="font-lightbold text-lg mt-8">Special prize categories</h3>
</ul>

<p class="font-light mt-5">
Congratulations for everyone who entered in the contest, and thanks a lot to our sponsors.
Congratulations to everyone who entered the contest, and thanks a lot to our sponsors.
</p>

<h2 class="font-lightbold mt-5 text-lg">Here is a list of all the valid submissions:</h2>
Expand All @@ -90,18 +90,17 @@ <h2 class="font-lightbold mt-5 text-lg">Here is a list of all the valid submissi
<p class="font-light mt-5"><b>Next Step: </b>Prize Delivery.</p>

<p class="font-light">If you are one of the lucky few who won one of
the prizes above then you will be getting a e-mail from us shortly asking for
the prizes above, you will be getting a e-mail from us shortly asking for
your shipping address. </p>

<p class="font-light mt-2">If you are not one of the lucky winners then don't worry, you still get
<p class="font-light mt-2">If you are not one of the lucky winners, don't worry. You will still get
the kivy t-shirt if you had one of the valid entries listed above. Wait for
our e-mail to confirm your shipping address.</p>

<p class="font-light mt-1">Don't forget to send us your pics with your prizes and t-shirts.</p>
<p class="font-light mt-1">Don't forget to send us your pics with your prizes and t-shirts!</p>

<p class="font-light mt-1 mb-5">This has been an amazing response from the community, folks thanks a lot
for
your entries and keep the love flowing.</p>
<p class="font-light mt-1 mb-5">This has been an amazing response from the community, folks. Thanks a lot
for your entries and keep the love flowing.</p>
</div>
<div class="w-full md:w-1/3">
<h3 class="text-3xl pb-5 text-center">Our sponsors</h3>
Expand Down
2 changes: 1 addition & 1 deletion templates/gallery.html
View file
Expand Up @@ -14,7 +14,7 @@ <h1 class="text-3xl pb-5">
</h1>
<p class="pb-5 font-light text-base">
What is the best way to learn more about the Kivy framework potential?
A list of projects built via Kivy, curated by the community itself!<br><br>
A list of projects built via Kivy curated by the community itself!<br><br>
Want to feature your project here? <a class="text-sm underline" href="https://www.github.com/kivy/kivy-website">Feel free to open a PR!</a>
</p>
<div class="flex flex-wrap">
Expand Down
12 changes: 6 additions & 6 deletions templates/index.html
View file
Expand Up @@ -12,7 +12,7 @@
<h1>
<span class="text-6xl font-extrabold">Kivy:</span>
<p class="text-4xl font-extrabold">
The Open Source Python App development Framework.
The Open Source Python App Development Framework.
</p>
</h1>
<h2 class="text-lg font-bold mt-2">
Expand Down Expand Up @@ -64,11 +64,11 @@ <h2 class="text-lg font-bold mt-2">
<b>Business Friendly</b>
</p>
<p class="text-lg md:text-xl font-light text-center">
<b>Kivy</b> is released under the <b>MIT License</b> and is
<b>100%</b> free to use and is professionally developed, backed and
<b>Kivy</b> is released under the <b>MIT License</b>, is
<b>100%</b> free to use, and is professionally developed, backed and
mantained.<br /><br />
<b>Companies</b> and <b>individual</b> are using Kivy for their
projects <b>everyday</b>.
<b>Companies</b> and <b>individuals</b> are using Kivy for their
projects <b>every day</b>.
</p>
</div>
<div class="w-full sm:w-1/3 pt-4 sm:pt-0">
Expand All @@ -87,7 +87,7 @@ <h2 class="text-lg font-bold mt-2">
</p>
<div id="opencollective_app" class="flex px-5 flex-wrap justify-center">
<p class="w-full text-xl font-light text-center pb-5">
{{organizations.length}} <b>organizations</b> are <b>supporting Kivy</b>
{{organizations.length}} <b>organizations</b> are <b>supporting Kivy</b>:
</p>
<a v-bind:href="organization.profile" class="w-1/2 md:w-1/3 lg:w-1/5 p-2 xl:p-5"
v-for="organization in organizations.slice(0, 5)">
Expand Down
8 changes: 4 additions & 4 deletions templates/kivy-launcher-privacy.html
View file
Expand Up @@ -14,16 +14,16 @@ <h1 class="text-4xl pb-5">
</h1>
<div class="pb-5 font-light">
<p>
Kivy Launcher is an open source app created by the Kivy developers. This SERVICE is provided at no cost
and without warranty of any kind, please
Kivy Launcher is an open source app created by the Kivy developers. This service is provided at no cost
and without warranty of any kind. Please
check the <a class="underline" href="https://github.com/kivy/kivy/blob/master/LICENSE">license</a> for more information.
</p>

<h2 class="font-bold text-lg mt-5">Information Collection and Use</h2>

<p>
We do not collect nor use any personal information in the Kivy Launcher. We may receive native crash
reports if you decide to submit them using the default method for Android applications.
We neither collect nor use any personal information in the Kivy Launcher. If you decide to submit native crash reports,
we will receive them using the default method for Android applications.
</p>

<h2 class="font-bold text-lg mt-5">Permissions</h2>
Expand Down

0 comments on commit 7c5e347

Please sign in to comment.