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 installation documentation #74

Open
bworrell opened this Issue Mar 17, 2014 · 3 comments

Comments

Projects
None yet
3 participants
@bworrell
Contributor

bworrell commented Mar 17, 2014

Currently the Getting Started wiki provides details on how to install and use python-stix. Adding more docs on how to upgrade and check your current version would be helpful.

@bschmoker

This comment has been minimized.

Contributor

bschmoker commented Aug 20, 2014

seems like the readme covers this pretty well?

I confirmed that the ubuntu instructions were current - added zlib since that's needed for a clean build in this branch

@gtback

This comment has been minimized.

Contributor

gtback commented Aug 21, 2014

@bworrell: What else needs to be added to call this done? I think a section on determining the current version (import stix; print stix.__version__) would be helpful, either on the wiki or on readthedocs (or both).

I would really like to trim down what's in the README and point people to ReadTheDocs for more information.

@bworrell

This comment has been minimized.

Contributor

bworrell commented Aug 21, 2014

@bschmoker @gtback,

Thanks for taking care of this and looking things over! The updates to the README look good :) I agree with @gtback that trimming down the README would be a good idea--maybe just getting rid of the Layout section since much of that is covered by the API Reference section in RTD. I'm a bit torn on trimming out too much--I don't like having to update the same information in multiple places, but I think some of it probably should belong in the README...hmmm. Thoughts?

I think adding an Upgrading section in the Installation section of RTD would be awesome. It could cover things like checking your version via the method that @gtback mentions, and pip freeze.

We should also add a Terms section to the README. Something like https://github.com/STIXProject/stix-validator#terms

@gtback gtback self-assigned this Aug 22, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment