Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[#74] Add proper README and project description #76

Merged
merged 2 commits into from
Jun 19, 2022
Merged

[#74] Add proper README and project description #76

merged 2 commits into from
Jun 19, 2022

Conversation

MagicRB
Copy link
Contributor

@MagicRB MagicRB commented Apr 22, 2022

Signed-off-by: Magic_RB [email protected]

Description

Update README.md, add description to package.yaml and CLI.Parser.parserInfo

Related issue(s)

#62, #56, #37, we need at least one of these done, so that we can start writing a proper /doc/, without another backend, it's hard to write good docs.

It would also have a stable release, we could point to in the README, so this is blocked by an MVP too.

Fixed #74

✅ Checklist for your Pull Request

Related changes (conditional)

  • Tests

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from
      silently reappearing again.

  • Documentation

    • I checked whether I should update the docs and did so if necessary:

Stylistic guide (mandatory)

@MagicRB MagicRB force-pushed the #74-readme-and-project-description branch from 9337566 to 8a0a31e Compare April 22, 2022 17:15
@MagicRB
Copy link
Contributor Author

MagicRB commented Apr 22, 2022

The logo does't have a license file as of now, idk what to license it under, some CC probably would be good.

dcastro
dcastro requested changes May 5, 2022
View reviewed changes
dcastro
dcastro reviewed May 5, 2022
View reviewed changes
dcastro
dcastro reviewed May 5, 2022
View reviewed changes
@DK318 DK318 force-pushed the #74-readme-and-project-description branch from 8a0a31e to 0ab5af5 Compare May 30, 2022 16:34
dcastro
dcastro requested changes Jun 5, 2022
View reviewed changes
dcastro
dcastro approved these changes Jun 6, 2022
View reviewed changes
Copy link
Member

@dcastro dcastro left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@dcastro dcastro requested a review from Kariel-Myrr June 6, 2022 17:13
@dcastro dcastro marked this pull request as ready for review June 19, 2022 11:14
@dcastro dcastro force-pushed the #74-readme-and-project-description branch from e17277e to 36c00da Compare June 19, 2022 11:17
MagicRB and others added 2 commits June 19, 2022 12:17
@MagicRB @dcastro
[#74] Add proper README and project description
358e515 
Signed-off-by: Magic_RB <[email protected]>
@DK318 @dcastro
[#74] Add stack to flake.nix
642021d 
Problem: if we setup development environment with `nix flakes`, then
we wouldn't get `stack` installed. But it is needed for some scripts.

Solution: add `stack` to `flake.nix`.
@dcastro dcastro force-pushed the #74-readme-and-project-description branch from 36c00da to 642021d Compare June 19, 2022 11:17
@dcastro dcastro merged commit 586c711 into main Jun 19, 2022
@dcastro dcastro deleted the #74-readme-and-project-description branch June 19, 2022 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DK318 DK318 DK318 left review comments

@dcastro dcastro dcastro approved these changes

@Kariel-Myrr Kariel-Myrr Awaiting requested review from Kariel-Myrr

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Readme and project description
3 participants
@MagicRB @dcastro @DK318