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

General Documentation #13

Closed
elkowar opened this issue Oct 14, 2020 · 5 comments
Closed

General Documentation #13

elkowar opened this issue Oct 14, 2020 · 5 comments
Assignees
@Swexti
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@elkowar
Copy link
Owner

elkowar commented Oct 14, 2020

Eww should have documentation that explains the general concepts and CLI of eww.
These docs should go into a docs directory in the project, which may later be used to turn it into a github-pages site.

Acceptance Criteria

  • Documentation explaining the basic idea, command line interface, and structure of eww is written and referenced in the Readme.
    • general concepts include explaining what widgets and windows are, and how eww relates to GTK
@elkowar elkowar added documentation Improvements or additions to documentation hacktoberfest labels Oct 14, 2020
@tushgaurav
Copy link

#16

@Swexti
Copy link
Contributor

Swexti commented Oct 14, 2020

since your documentation is so fucking shit and you simply split the readme into 3 different parts and actually not add anything. I'll take over the documentation and actually write documentation.

@tushgaurav
Copy link

I'm so sorry!

@elkowar
Copy link
Owner Author

elkowar commented Oct 16, 2020

No worries @tushgaurav , we all want that free t-shirt 😅 there's just better ways, such as actually contributing something of value

elkowar pushed a commit that referenced this issue Oct 17, 2020
@Swexti
Add configuration docs (#17)
778a3bf 
* Add general and configuration documentation

closes #17 #13
@elkowar
Copy link
Owner Author

elkowar commented Oct 17, 2020

implemented in #17

@elkowar elkowar closed this as completed Oct 17, 2020
elkowar pushed a commit that referenced this issue Oct 18, 2020
@Swexti @elkowar
Add configuration docs (#17)
e00685e 
* Add general and configuration documentation

closes #17 #13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Swexti Swexti

Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@elkowar @tushgaurav @Swexti