diff --git a/README b/README index 98bfa2a..0be572b 100644 --- a/README +++ b/README @@ -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", @@ -31,23 +31,21 @@ As an example, with the following configuration: ... ``` And the following snippet in `index.html` -``` +```html

Hi, [[ =name ]]

``` Will produce the following output, when the template has been built: -``` +```html

Hello, Kivy

``` -## 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: @@ -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 diff --git a/templates/about.html b/templates/about.html index f67fe79..fe23801 100644 --- a/templates/about.html +++ b/templates/about.html @@ -13,13 +13,13 @@

About us

- Kivy is a community project, led by professional software developers, who are responsible - for developing and supporting Kivy, alongside of the community. We also work for + Kivy is a community project led by professional software developers who are responsible + for developing and supporting Kivy alongside of the community. We also work for companies that use Kivy for their professional products.

Many people have contributed to Kivy and we're always interested in growing our - community. If you want to help in terms of writing code, improving documentation, - testing, etc. or simply making a donation, please do not hesitate to contact us. + community. If you want to help by doing things like writing code, improving documentation or + testing, or even if you simply want to make a donation, please do not hesitate to + contact us.

@@ -72,7 +72,7 @@

[[ pass ]]
-

You made a talk but is not listed here? +

You made a talk, but it's not listed here? Feel free to open a PR! @@ -88,12 +88,11 @@

- 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 2012 and 2014.
- 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.

+ 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.

Is a new contest coming soon? Follow us on Twitter to keep in touch!

diff --git a/templates/contest-2012.html b/templates/contest-2012.html index 36be39f..d3201f1 100644 --- a/templates/contest-2012.html +++ b/templates/contest-2012.html @@ -38,9 +38,9 @@

The winners are:

- 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 Notionink and Github + href="https://github.com/plans">Github.

Goals of the Contest

    @@ -89,7 +89,7 @@

    Prizes

    2nd Place @@ -134,43 +134,42 @@

    Rules

    The participant must licence the game under an OSS licence.
  • - 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 - Setup Git, - Create a repository and add your code in - it. - 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 + setup Git and + create a repository for your code.) + Don't wait until the deadline to do it!
  • - 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.
  • The participant must respect the Application - layout defined in Kivy documentation.
    - 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 defined in the Kivy documentation.
    + The game must run on the latest Kivy (1.0.9) with the command "python main.py"
  • - Usage of externals libraries using ctypes, compiled extensions or - specific OS code are forbidden. + Use of external libraries via ctypes, compiled extensions, or + specific OS code is forbidden.
  • - 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.
  • - 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.
  • - Any Adult or Offensive content is forbidden. The game should be kids friendly. + Any adult or offensive content is forbidden. The game should be for all ages.
  • - 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.
    • diff --git a/templates/contest-2014.html b/templates/contest-2014.html index 21f6c89..fbb32be 100644 --- a/templates/contest-2014.html +++ b/templates/contest-2014.html @@ -72,7 +72,7 @@

    Special prize categories

- 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.

Here is a list of all the valid submissions:

@@ -90,18 +90,17 @@

Here is a list of all the valid submissi

Next Step: Prize Delivery.

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.

-

If you are not one of the lucky winners then don't worry, you still get +

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.

-

Don't forget to send us your pics with your prizes and t-shirts.

+

Don't forget to send us your pics with your prizes and t-shirts!

-

This has been an amazing response from the community, folks thanks a lot - for - your entries and keep the love flowing.

+

This has been an amazing response from the community, folks. Thanks a lot + for your entries and keep the love flowing.

Our sponsors

diff --git a/templates/gallery.html b/templates/gallery.html index 87495b7..046d484 100644 --- a/templates/gallery.html +++ b/templates/gallery.html @@ -14,7 +14,7 @@

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!

+ A list of projects built via Kivy curated by the community itself!

Want to feature your project here? Feel free to open a PR!

diff --git a/templates/index.html b/templates/index.html index 7839cdc..529bf3d 100644 --- a/templates/index.html +++ b/templates/index.html @@ -12,7 +12,7 @@

Kivy:

- The Open Source Python App development Framework. + The Open Source Python App Development Framework.

@@ -64,11 +64,11 @@

Business Friendly

- Kivy is released under the MIT License and is - 100% free to use and is professionally developed, backed and + Kivy is released under the MIT License, is + 100% free to use, and is professionally developed, backed and mantained.

- Companies and individual are using Kivy for their - projects everyday. + Companies and individuals are using Kivy for their + projects every day.

@@ -87,7 +87,7 @@

- {{organizations.length}} organizations are supporting Kivy + {{organizations.length}} organizations are supporting Kivy:

diff --git a/templates/kivy-launcher-privacy.html b/templates/kivy-launcher-privacy.html index 7eb1d04..ce577fd 100644 --- a/templates/kivy-launcher-privacy.html +++ b/templates/kivy-launcher-privacy.html @@ -14,16 +14,16 @@

- 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 license for more information.

Information Collection and Use

- 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.

Permissions