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

Clarify installation procedures #852

Merged
merged 1 commit into from
Apr 26, 2019
Merged

Conversation

awwad
Copy link
Contributor

@awwad awwad commented Apr 8, 2019

This PR:

  • Moves full install instructions to INSTALLATION.rst (from CONTRIBUTORS.rst)
  • Notes in the installation instructions that if errors occur while installing the optional crypto dependencies, that the non-Python dependencies section should be consulted.
  • Adds a git clone step to the development installation instructions in the contributors' instructions
  • Adds other minor installation notes for contributors.

I'm just going to tolerate the fact that we use both reStructuredText and Markdown for now, but I think we'll switch the rsts to Markdown later.......

This PR helps deal with issue #808.

@awwad awwad added the documentation Documentation of the project as well as procedural documentation label Apr 8, 2019
@awwad awwad force-pushed the better_installation_instructions branch 9 times, most recently from 5e2aa10 to 3635c31 Compare April 8, 2019 21:11
and note that if errors occur while installing the optional
crypto dependencies, that the non-Python dependencies section
should be consulted.

Also adds a git clone step to the development installation
instructions in the contributors' instructions, and other
minor installation notes for contributors.

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
@awwad awwad force-pushed the better_installation_instructions branch from 3635c31 to 56a2928 Compare April 8, 2019 21:13
@awwad awwad requested a review from SantiagoTorres April 8, 2019 21:17
@awwad awwad changed the title Move full install instructions to INSTALLATION.rst Clarify installation procedures Apr 9, 2019
@awwad awwad merged commit 4ad65e2 into develop Apr 26, 2019
@awwad awwad deleted the better_installation_instructions branch May 2, 2019 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation of the project as well as procedural documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant