Skip to content
Open

Typo #36

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@

# Objective

This project intend to allow everyone to create cheatsheet without programming skills.
The main objectives are :
- Build a **easy-to-use** and **easy-to-maintain** engine to generate cheatsheets
- Use the well known **markdown** format to create it
- Offer a way to create and use different **templates** to render document
- Automatically build a website with all created cheatsheets
- Allow to export it as a simple recto-verso PDF
This project intends to allow everyone to create cheatsheets without programming skills.
The main objectives are:
- Build a **easy-to-use** and **easy-to-maintain** engine to generate cheatsheets.
- Use the well known **markdown** format to create it.
- Offer a way to create and use different **templates** to render documents.
- Automatically build a website with the newly created cheatsheet.
- Allow to export it as a simple recto-verso PDF.

![workflow](https://github.com/zenika-open-source/cheatsheets/blob/main/workflow.png?raw=true)

## Live demo
You can explore a live demo of this project [here](https://zenika-open-source.github.io/cheatsheets/)
You can explore a live demo of this project [here](https://zenika-open-source.github.io/cheatsheets/).

## Quick Start
To create your very first cheatsheets, follow this [Quick Start Guide](https://zenika-open-source.github.io/cheatsheets/quick-start/)
To create your very first cheatsheets, follow this [Quick Start Guide](https://zenika-open-source.github.io/cheatsheets/quick-start/).

## Template Configuration
Cheatsheets are generated from Markdown files located in the `cheatsheets` folder. To configure the template and styles used in generating the Markdown, please refer to the `config.json` file. To understand how it works and how you can configure it, please follow the [Template Grid Flow](https://zenika-open-source.github.io/cheatsheets/template-grid-flow/).
Expand Down
4 changes: 2 additions & 2 deletions cheatsheets/conventional-commit/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
::: column

# What is it ?
# What is it?

A Conventional Commit is a standardized way of writing commit messages in version control systems like Git. It follows a specific format to make it easier to understand the purpose and scope of each commit. The Conventional Commit format is commonly used in projects that follow semantic versioning (semver) and use tools like Lerna to automate the release process.

Expand All @@ -19,7 +19,7 @@ Here's a cheatsheet to help you understand and use Conventional Commits:
# Types

- **feat**: A new feature or functionality added to the project.
- **fix**: A bug fix or correction to existing code.
- **fix**: A bugfix or correction to existing code.
- **chore**: Routine tasks, maintenance, or non-functional changes.
- **docs**: Documentation updates or additions.
- **style**: Code style, formatting, or whitespace changes (not affecting the code's behavior).
Expand Down
12 changes: 6 additions & 6 deletions cheatsheets/esp32/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
| - WiFi 2.4Ghz | - Analog GPIO |
| - Bluetooth | - Touch sensor |
| - 240Mhz dual core | - Hall sensor |
| - Digital GPIO | - I2C, SPI, SD, UART,... |
| - Digital GPIO | - I2C, SPI, SD, UART . . . |


# GPIOs digital specificities
Expand Down Expand Up @@ -109,7 +109,7 @@ void loop() {
}
Serial.print("Hello");
Serial.println(" World");
// Not mandatory, wait for transmission finish
// Not mandatory, wait for transmission to finish
Serial.flush();
}
```
Expand All @@ -123,7 +123,7 @@ interrupts(); // re-enable all interruptions
```

# Mutli threading
/!\ do not overload core 0, this core control WiFi
/!\ do not overload core 0 as it controls WiFi

```cpp
// core: 0 or 1
Expand All @@ -132,7 +132,7 @@ xTaskCreatePinnedToCore(taskFunc, threadName, stackSize,
parameters, priority, &taskRef, core);
vTaskDelete(taskRef);

// example :
// example:
TaskHandle_t myThreadTask;
xTaskCreatePinnedToCore(myThread, "My thread", 10000,
NULL, 2, &myThreadTask, 0);
Expand Down Expand Up @@ -235,9 +235,9 @@ void loop() {
```


Note that `server.handleClient();` is mandatory to tell the lib to check network stack request buffer.
Note that `server.handleClient();` is mandatory to tell the lib to check the network stack request buffer.

Otherwise, request from clients will not be accept.
Otherwise, request from clients will not be accepted.

The longer the delay between `handleClient` the longer the request connection will take.
:::
Loading