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

Refactor Readme, build docs. #178

Open
indolering opened this issue Sep 18, 2014 · 2 comments
Open

Refactor Readme, build docs. #178

indolering opened this issue Sep 18, 2014 · 2 comments

Comments

@indolering
Copy link

The readme and build instructions in doc are ancient.

Readme

Namecoin-QT does not currently build on OS X as claimed in the readme. This should be updated until a PR for Namecoin-QT is submitted.

I also believe that we should mark this repo as deprecated and in maintenance mode, so as to prevent people from wasting time on futile projects.

Build Docs

Almost everything in doc is inaccurate, especially the OS X and Windows docs. We should either update them or migrate instructions to the main readme and remove them.

@phelixbtc
Copy link
Contributor

Yup.
Readme.md only needs a little polishing. FAQ.md, DESIGN-namecoin.md and DEVELOPMENT-PROCESS.md should be moved to doc IMHO.
doc/README and doc/README_windows.txt can be removed.
doc/build* need to be updated.

About the maintenance mode: People should discuss large changes up front on the forum.

@indolering
Copy link
Author

About the maintenance mode: People should discuss large changes up front on the forum.

Agreed

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

No branches or pull requests

2 participants