Skip to content

Create readme#71

Merged
gomezzz merged 52 commits intomainfrom
create_README
Dec 20, 2022
Merged

Create readme#71
gomezzz merged 52 commits intomainfrom
create_README

Conversation

@GabrieleMeoni
Copy link
Collaborator

Description

Added README
Summary of changes
Improving README by adding:

  • About the project
  • Summary
  • Images
  • Examples
  • Glossary
  • Info on PASEOS constraints

Missing

  • How to perform an activity
  • Grammar and spell check
  • #PR

@GabrieleMeoni GabrieleMeoni added documentation Improvements or additions to documentation example An example to showcase something user-facing Anything that users can interact with labels Dec 12, 2022
@GabrieleMeoni GabrieleMeoni marked this pull request as draft December 12, 2022 18:53
Copy link
Collaborator

@gomezzz gomezzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like where it's going! I have to do something else now, will give more comments in the next iteration of review

README.md Outdated
```

### How to add a power device
The following code snippet shows how to add a power device to `SatA`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explain briefly that we support solar power only atm and that it will charge when not in eclipse. Also, we should only support one power device right now, I think? 🤔 probably everything breaks if you try to add a second? 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I never tried...

GabrieleMeoni and others added 9 commits December 13, 2022 09:41
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
@gomezzz gomezzz mentioned this pull request Dec 13, 2022
1 task
This was referenced Dec 19, 2022
Copy link
Collaborator

@gomezzz gomezzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see suggestions 🙏

love the linking to glossary btw 💪

GabrieleMeoni and others added 8 commits December 20, 2022 09:56
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Co-authored-by: Pablo Gómez <contact@pablo-gomez.net>
Fixing grammar.
@GabrieleMeoni GabrieleMeoni changed the title [WIP] - Create readme Create readme Dec 20, 2022
@GabrieleMeoni GabrieleMeoni marked this pull request as ready for review December 20, 2022 10:40
@gomezzz gomezzz merged commit af94a82 into main Dec 20, 2022
@gomezzz gomezzz deleted the create_README branch December 20, 2022 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation example An example to showcase something user-facing Anything that users can interact with

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants