Giter VIP home page Giter VIP logo

esp-toolchain-docs's Introduction

esp-toolchain-docs's People

Contributors

gerekon avatar igrr avatar lapshin avatar lu-zero avatar o-marshmallow avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

esp-toolchain-docs's Issues

Documentation for QEMU is confusing, inaccurate and insufficient.

The documentation for QEMU RGB Panel is confusing and insufficient. First, under the Build and Run section, the user is instructed to build the project, but it doesn't specify type of image it will build. Will it build for the actual device or QEMU? There are no instructions for running the image. Instead, you're linked to a very general QEMU readme, which begins by instructing the user on how to build QEMU. It doesn't specify a link to the git repository containing the source to build. It becomes a detective game to discover it. After an hour or so of dead ends trying to build it, I found a prebuilt binary which was never mentioned in the documentation, resulting wasted effort.

Second, halfway down the QEMU docs page there are instructions on how to run the image. The example command-lines given are very generalized and unclear whether they will work for the built image. I couldn't get the image to execute due to an invalid binary format. It would be enormously helpful if the examples were specific instead of generalized.

Third, after many hours spent trying to get the example to run, I discovered QEMU was already installed and could be run by running idf.py qemu with the correct parameters. Unfortunately, the QEMU RGB Panel example disables the QEMU display by default.

This is why many users don't bother to read the documentation. They are often poorly written, leading to confusion, and frustration. Many developers often don't value writing decent documentation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.