Skip to content
This repository has been archived by the owner on Jun 6, 2019. It is now read-only.

Adding documentation #142

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

WojcikMike
Copy link
Contributor

@WojcikMike WojcikMike commented Jul 18, 2016

Adding a document holding brief description of the most important projects and configuration details.

Connects to Particular/NDCSydney2016#23

cc: @Particular/hashbus-maintainers

The purpose of this document is to describe how to set up HashBus to monitor tweets and display leaderboard.

## Projects
Below is a brief description of existing executables
Copy link
Member

Choose a reason for hiding this comment

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

I think this line can be omitted.

@adamralph
Copy link
Member

adamralph commented Jul 18, 2016

@WojcikMike thanks, it looks good!

I left a couple of comments, chiefly about the placement and purpose of the doc. There are several places where the language can be improved but we can address that later after we consider the placement and structure of this information with respect to the root README.md and the linked file above.

@WojcikMike
Copy link
Contributor Author

WojcikMike commented Jul 19, 2016

I was aware of readme.md file but not of TwitterLeaderboard.md file. Given all the context would divide it into 2 documents:

  • Readme.md - I would add there my section of configuration that actually is important for people setting up the project
  • ***.md - I would move business description from TwitterLeaderboard + projects description from my PR. However i would prefer this md file to live within HashBus repo.

@adamralph
Copy link
Member

I think as much possible should be public and in the root README of this repo. It's probably best to take a look at the state of that README and decide how the overall structure should look. It can change from it's current form completely.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants