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.

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

add roadmap to README #22

Merged
merged 2 commits into from
Jan 12, 2016
Merged

Conversation

candeira
Copy link
Contributor

Roadmap is very much work in progress, but should help us make a better one and split up the work.

  • moved from .rst format to .md for github-native checklists
  • added a roadmap inspired from js-ipfs README
  • added Contribution guide also cribbed from js-ipfs

subpackages `block`, `merkledag`, `naming`, and `routing`, which function as
laid out in the main IPFS repo_.

.. _repo: http://github.com/ipfs/ipfs
Copy link
Contributor

Choose a reason for hiding this comment

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

Errant italics?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, from converting from .rst to .md (because Github doesn't do checklists from .rst). Will fix it later.

Copy link
Contributor

Choose a reason for hiding this comment

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

Why later?

Do you know how to amend commits and force push (not everyone does! you probably do, just checking)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi RichardLitt. "later" because I was reading on a mobile phone while on holidays. I do know how to amend and force push :)

@RichardLitt
Copy link
Contributor

Looks pretty good to me! I added some comments.

@candeira
Copy link
Contributor Author

candeira commented Jan 4, 2016

Updated to address @RichardLitt's comments.

  - moved from .rst format to .md for github-native checklists
  - added a roadmap inspired from js-ipfs README
  - added Contribution guide also cribbed from js-ipfs
  - roadmap is very much work in progress, but should help us make
    a better one and split up the work.
@ivilata
Copy link
Contributor

ivilata commented Jan 12, 2016

Pretty complete and useful for newcomers like me, thanks! I hope to see this merged.

I'm attaching a few minor corrections to typography and outdated links. README.md.diff.txt

@RichardLitt
Copy link
Contributor

Let's just merge this. @ivilata, can you PR those diffs?

RichardLitt added a commit that referenced this pull request Jan 12, 2016
@RichardLitt RichardLitt merged commit e47ede3 into ipfs-shipyard:master Jan 12, 2016
@RichardLitt
Copy link
Contributor

Thanks, @candeira!

@candeira candeira deleted the readme-roadmap branch January 12, 2016 20:50
@candeira
Copy link
Contributor Author

Thanks, @RichardLitt.

@diasdavid updated his own roadmap today, so we might need to revise after @ivilata's PR has gone in. Restoring the branch...

@candeira candeira restored the readme-roadmap branch January 12, 2016 20:51
ivilata added a commit to ivilata/py-ipfs that referenced this pull request Jan 13, 2016
@ivilata
Copy link
Contributor

ivilata commented Jan 13, 2016

@RichardLitt, I just added the changes as PR #26, thanks!

RichardLitt added a commit that referenced this pull request Jan 13, 2016
minor corrections to typography and links after merging #22
@ralphbean
Copy link
Contributor

Oh -- note that I think this broke setup.py which expected the README to be called README.rst.

ralphbean added a commit to ralphbean/py-ipfs that referenced this pull request Jan 27, 2016
Usage of setup.py and ``tox`` broke in ipfs-shipyard#22 when the file got renamed.
@ralphbean ralphbean mentioned this pull request Jan 27, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants