And some minor fixes (proposal)
This commit is contained in:
Darío Hereñú 2017-12-10 00:51:29 -03:00 коммит произвёл Ken McMillan
Родитель b7785164f3
Коммит eeaf7fa85d
1 изменённых файлов: 21 добавлений и 21 удалений

Просмотреть файл

@ -26,7 +26,7 @@ installed by the second command.
The Windows binary distribution is in the form of a zip The Windows binary distribution is in the form of a zip
archive. Download the file `ivy.X.Y-.Windows-z86.zip`, where `X.X` is archive. Download the file `ivy.X.Y-.Windows-z86.zip`, where `X.X` is
the IVy version (this will work on both 32-bit and 64 bit Intel the IVy version (this will work on both 32-bit and 64 bit Intel
Windows). Use Windows Explorere to extract this archive in the Windows). Use Windows Explorer to extract this archive in the
directory `C:\`. This should give you a directory `C:\ivy`. To use IVy directory `C:\`. This should give you a directory `C:\ivy`. To use IVy
in a command window, first execute this command: in a command window, first execute this command:
@ -41,14 +41,14 @@ below.
# Installing in a virtual environment with Vagrant # Installing in a virtual environment with Vagrant
IVy users and contributors may also deploy IVy within an container IVy users and contributors may also deploy IVy within an container
using [Vagrant](http://vagrantup.com). using [Vagrant](https://www.vagrantup.com/).
### Windows ### Windows
On Windows, [Virtualbox](http://virtualbox.org) is currently the recommended container provider. On Windows, [Virtualbox](https://virtualbox.org) is currently the recommended container provider.
1. Clone the `IVy` repository (e.g. `git clone https://github.com/Microsoft/ivy.git`). 1. Clone the `IVy` repository (e.g. `git clone https://github.com/Microsoft/ivy.git`).
2. Download and install [Vagrant](http://vagrantup.com). 2. Download and install [Vagrant](https://www.vagrantup.com/).
3. Download and install [Virtualbox](http://virtualbox.org). 3. Download and install [Virtualbox](http://virtualbox.org).
4. Type `vagrant plugin install vagrant-vbguest` to install the [`vagrant-vbguest`](https://github.com/dotless-de/vagrant-vbguest) plugin (optional but recommended). 4. Type `vagrant plugin install vagrant-vbguest` to install the [`vagrant-vbguest`](https://github.com/dotless-de/vagrant-vbguest) plugin (optional but recommended).
5. Download and install an X11 server for Windows (e.g. [Xming](http://www.straightrunning.com/XmingNotes/)). 5. Download and install an X11 server for Windows (e.g. [Xming](http://www.straightrunning.com/XmingNotes/)).
@ -57,11 +57,11 @@ On Windows, [Virtualbox](http://virtualbox.org) is currently the recommended con
### Linux ### Linux
On Linux, [Docker](http://docker.com) is also available as a container provider, and will yield better performance than the Virtualbox backend. On Linux, [Docker](https://docker.com) is also available as a container provider, and will yield better performance than the Virtualbox backend.
1. Clone the `IVy` repository (e.g. `git clone https://github.com/Microsoft/ivy.git`). 1. Clone the `IVy` repository (e.g. `git clone https://github.com/Microsoft/ivy.git`).
2. Install [Vagrant](http://vagrantup.com). 2. Install [Vagrant](https://www.vagrantup.com/).
3. Install [Docker](http://docker.com). 3. Install [Docker](https://docker.com).
4. (Debian-based systems) Ensure your user is in the `docker` group. 4. (Debian-based systems) Ensure your user is in the `docker` group.
5. Type `vagrant up --provider=docker`. 5. Type `vagrant up --provider=docker`.
6. Type `vagrant ssh` to get access to IVy from a shell. 6. Type `vagrant ssh` to get access to IVy from a shell.
@ -76,7 +76,7 @@ Linux users also have the option of directly executing the provisioning scripts
# Installing from source # Installing from source
This document describes the steps need to install IVy from the github This document describes the steps need to install IVy from the Github
repository. The specific commands given apply to Ubuntu Linux version repository. The specific commands given apply to Ubuntu Linux version
14.04. Windows and Mac users should also refer to the Windows and Mac 14.04. Windows and Mac users should also refer to the Windows and Mac
notes below. notes below.
@ -102,7 +102,7 @@ installation instructions:
### Z3 ### Z3
Follow the instructions [here](https://github.com/Z3Prover/z3) to Follow the instructions [here](https://github.com/Z3Prover/z3) to
install Z3. You can test whether Z3 is correctly installed like this: install Z3. You can test whether Z3 is correctly installed running this:
$ python $ python
>>> import z3 >>> import z3
@ -114,14 +114,14 @@ like this:
### Python packages ### Python packages
Install the python packages ply, pygraphviz and tarjan. On Ubuntu, install them Install the python packages `ply`, `pygraphviz` and `tarjan`. On Ubuntu, install them
like this: like this:
$ sudo apt-get install python-ply python-pygraphviz $ sudo apt-get install python-ply python-pygraphviz
$ pip install tarjan $ pip install tarjan
Make sure you get version 3.4 of python-ply as some later versions are broken. Make sure you get version 3.4 of python-ply as some later versions are broken.
As an alternative, pip can install all the packages, but you need to make sure As an alternative, `pip` can install all the packages, but you need to make sure
the dependencies on system packages are met: the dependencies on system packages are met:
$ sudo apt-get install graphviz graphviz-dev python-dev $ sudo apt-get install graphviz graphviz-dev python-dev
@ -171,16 +171,16 @@ Run Ivy on an example, like this:
## Emacs mode ## Emacs mode
An emacs major mode for Ivy is available in lib/emacs/ivy-mode.el. Put this file An emacs major mode for Ivy is available in `lib/emacs/ivy-mode.el`. Put this file
somewhere in your emacs load path and add the following code to your somewhere in your emacs load path and add the following code to your
.emacs: `.emacs`:
(add-to-list 'auto-mode-alist '("\\.ivy\\'" . ivy-mode)) (add-to-list 'auto-mode-alist '("\\.ivy\\'" . ivy-mode))
(autoload 'ivy-mode "ivy-mode.el" "Major mode for editing Ivy code" t nil) (autoload 'ivy-mode "ivy-mode.el" "Major mode for editing Ivy code" t nil)
## Windows notes ## Windows notes
Installing on windows can be a bit challenging, but here are a few Installing on Windows can be a bit challenging, but here are a few
suggestions that may get you through it. suggestions that may get you through it.
### Installing Python and Python packages ### Installing Python and Python packages
@ -191,9 +191,9 @@ need to install the [Visual C++ compiler for Python](http://aka.ms/vcpython27).
### Installing Z3 ### Installing Z3
After installing Z3, you need to make sure Python can find it. You can try setting After installing Z3, you need to make sure Python can find it. You can try setting
the PYTHONPATH environment variable to point to the Z3 `bin` directory. It might the `PYTHONPATH` environment variable to point to the Z3 `bin` directory. It might
help to make sure Z3 is installed in a directory without spaces in the name. As a help to make sure Z3 is installed in a directory without spaces in the name. As a
last resort, you can just copy the '.py' and '.dll' files into your Python installation. last resort, you can just copy the `.py` and `.dll` files into your Python installation.
If you installed Python in `c:/Python27`, then copy the files into: If you installed Python in `c:/Python27`, then copy the files into:
c:/Python27/lib/site-packages/ c:/Python27/lib/site-packages/
@ -213,7 +213,7 @@ Install into some directory without spaces in the name, for example `c:/Graphviz
### Using scripts ### Using scripts
The `pip` package installation utility is found in `c:/Python27/Scripts`. You should put The `pip` package installation utility is found in `c:/Python27/Scripts`. You should put
this directory in your PATH, since the IVY command line scripts will also be installed there this directory in your `PATH`, since the IVY command line scripts will also be installed there
by default. Try installing the `tarjan` and `ply` packages like this: by default. Try installing the `tarjan` and `ply` packages like this:
> pip install tarjan > pip install tarjan
@ -225,9 +225,9 @@ You can try installing `pygraphviz` like this:
> pip install pygraphviz > pip install pygraphviz
However, this is likely to fail as pip will not find the graphviz However, this is likely to fail as `pip` will not find the graphviz
headers and libraries. As an alternative, download the release 1.3 of headers and libraries. As an alternative, download the release 1.3 of
pygraphviz from `pygraphviz` from
[here](https://github.com/pygraphviz/pygraphviz/releases). After unpacking [here](https://github.com/pygraphviz/pygraphviz/releases). After unpacking
the sources, do this: the sources, do this:
@ -290,7 +290,7 @@ several minutes to start.
In principle, it is also possible to use the native Aqua interface by In principle, it is also possible to use the native Aqua interface by
installing an appropriate python package. In this case, you might installing an appropriate python package. In this case, you might
install graphviz using MacPorts, and then install pygraphviz from install `graphviz` using MacPorts, and then install `pygraphviz` from
source as in the Windows notes above. This is untested, however. source as in the Windows notes above. This is untested, however.