StarMirror/interactive-coding-challenges
1
0
Fork 0
mirror of https://github.com/donnemartin/interactive-coding-challenges.git synced 2024-03-22 13:11:13 +08:00
Code Issues Projects Releases Wiki Activity

Swap install and run instructions order in README

Browse Source
This commit is contained in:
Donne Martin 2016-06-04 16:02:06 -04:00
parent dd44bda6e8
commit 6196947abe
1 changed files with 49 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
README.md
View File

@ -92,9 +92,9 @@ Challenges, solutions, and unit tests are presented in the form of **IPython/Jup
### Installing and Running Challenges
* [Repo Structure](#repo-structure)
* [Running Challenges](#running-challenges)
* [Notebook Installation](#notebook-installation)
* [Nose Installation](#nose-installation)
* [Nose Installation](#nose-installation)
* [Running Challenges](#running-challenges)
### Misc
@ -315,6 +315,52 @@ interactive-coding-challenges # Repo
<i>\*The notebooks (.pynb) read/write the associated unit test (.py) file.</i>
## Notebook Installation
### IPython Notebook
If you already have Python installed and are familiar with installing packages, you can get IPython Notebook with pip:
```
pip install "ipython[notebook]"
```
If you run into an issue about pyzmq, refer to the following [Stack Overflow post](http://stackoverflow.com/questions/24995438/pyzmq-missing-when-running-ipython-notebook) and run:
```
pip uninstall ipython
pip install "ipython[all]"
```
As an alternative, you can also use the provided ```requirements.txt``` file:
```
pip install -r requirements.txt
```
For detailed instructions, scripts, and tools to more optimally set up your development environment, check out the [dev-setup](https://github.com/donnemartin/dev-setup) repo.
For more details on notebook installation, follow the directions [here](http://ipython.org/install.html).
More information on IPython/Jupyter Notebooks can be found [here](http://ipython.org/notebook.html).
### Nose Tests
Install nose using setuptools/distribute:
```
easy_install nose
```
or
```
pip install nose
```
More information on Nose can be found [here](https://nose.readthedocs.org/en/latest/).
## Running Challenges
### Notebooks
@ -345,55 +391,6 @@ To **debug** your solution with pdb, refer to the following [ticket](https://git
Note: If your solution is different from those listed in the Solution Notebook, consider submitting a pull request so others can benefit from your work. Review the [Contributing Guidelines](https://github.com/donnemartin/interactive-coding-challenges/blob/master/CONTRIBUTING.md) for details.
### Nose Unit Tests
Unit tests are provided in the form of **Nose tests**.
*If you need to install Nose, see the [Nose Installation](#nose-installation) section.*
## Notebook Installation
If you already have Python installed and are familiar with installing packages, you can get IPython Notebook with pip:
```
pip install "ipython[notebook]"
```
If you run into an issue about pyzmq, refer to the following [Stack Overflow post](http://stackoverflow.com/questions/24995438/pyzmq-missing-when-running-ipython-notebook) and run:
```
pip uninstall ipython
pip install "ipython[all]"
```
As an alternative, you can also use the provided ```requirements.txt``` file:
```
pip install -r requirements.txt
```
For detailed instructions, scripts, and tools to more optimally set up your development environment, check out the [dev-setup](https://github.com/donnemartin/dev-setup) repo.
For more details on notebook installation, follow the directions [here](http://ipython.org/install.html).
More information on IPython/Jupyter Notebooks can be found [here](http://ipython.org/notebook.html).
## Nose Installation
Install nose using setuptools/distribute:
```
easy_install nose
```
or
```
pip install nose
```
More information on Nose can be found [here](https://nose.readthedocs.org/en/latest/).
## Contributing
Contributions are welcome!
@ -453,4 +450,4 @@ Feel free to contact me to discuss any issues, questions, or comments.
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.