Skip to content

Improve the README #183

Open
Open
Improve the README#183

Description

@jordanmontt
jordanmontt
opened on Feb 21, 2023

(Edited)
It would be nice to have some examples of how to get start in the README file. Also a quick getting started code snippet. And give a pass to the Readme in general :)

Activity

  1. Ducasse commented on Feb 21, 2023

    @Ducasse
    Ducasse
    on Feb 21, 2023

    Remember that in P11 you will be able to read the documentation that is located in the doc folder.

    S

  2. jordanmontt commented on Feb 22, 2023

    @jordanmontt
    jordanmontt
    on Feb 22, 2023
    MemberAuthor

    Yes, that is why we want to have a good README file with good documentation :)

  3. jordanmontt
    changed the title [-]Add quick starting example on the README[/-] [+]Improve the README[/+] on Feb 22, 2023

  4. jecisc commented on Mar 6, 2023

    @jecisc
    jecisc
    on Mar 6, 2023
    Member

    A quick start should be enough because there is a booklet with much more documentation provided also

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions