Merge pull request #139 from sqreen/documentation

Update Documentation

AUTHORS.rst

@@ -5,9 +5,10 @@ Credits
 Authors
 -------
 
-* Jean-Baptiste AVIAT <[email protected]>
-* Boris FELD <[email protected]>
-* Selim MENOUAR <[email protected]>
+* Jean-Baptiste AVIAT <[email protected]>
+* Boris FELD <[email protected]>
+* Selim MENOUAR <[email protected]>
+* Nicolas VIVET <[email protected]>
 
 Contributors
 ------------

CONTRIBUTING.rst

@@ -13,7 +13,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/sqreen/py_mini_racer/issues.
+Report bugs at https://github.com/sqreen/PyMiniRacer/issues.
 
 If you are reporting a bug, please include:
 
@@ -43,7 +43,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/sqreen/py_mini_racer/issues.
+The best way to send feedback is to file an issue at https://github.com/sqreen/PyMiniRacer/issues.
 
 If you are proposing a feature:
 
@@ -55,19 +55,22 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `py_mini_racer` for local development.
+Ready to contribute? Here's how to set up `PyMiniRacer` for local development.
 
-1. Fork the `py_mini_racer` repo on GitHub.
+1. Fork the `PyMiniRacer` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/py_mini_racer.git
+    $ git clone [email protected]:your_name_here/PyMiniRacer.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv py_mini_racer
-    $ cd py_mini_racer/
+    $ mkvirtualenv PyMiniRacer
+    $ cd PyMiniRacer/
+    $ python helpers/v8_build.py
     $ python setup.py develop
 
+**Warning**: building this package from source takes several GB of disk space and takes ~60 minutes.
+
 4. Create a branch for local development::
 
     $ git checkout -b name-of-your-bugfix-or-feature
@@ -99,11 +102,11 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 2.7, 3.4, 3.5, 3.6 and 3.7 and for PyPy.
+3. The pull request should work for Python 2.7, at least 3.5 and for PyPy.
 
 Tips
 ----
 
 To run a subset of tests::
 
-    $ python -m unittest tests.test_py_mini_racer
+    $ python -m unittest tests.test_eval

HISTORY.rst

@@ -4,138 +4,114 @@ History
 -------
 
 0.5.0 (2020-02-25)
---------------------
-
+'''''''''''''''''''
 * Update V8 to 8.8
 
 0.4.0 (2020-09-22)
-------------------
-
+'''''''''''''''''''
 * Universal wheels for Linux, Mac and Windows
 * Fallback to source package for Alpine Linux
 
 0.3.0 (2020-06-29)
-------------------
-
+'''''''''''''''''''
 * Introduce a strict mode
 * Fix array conversion when size changes dynamically (CVE-2020-25489)
 
 0.2.0 (2020-03-11)
-------------------
-
+'''''''''''''''''''
 * Support for Alpine Linux
 * Avoid pip private modules in setup.py
 
 0.2.0b1 (2020-01-09)
---------------------
-
+'''''''''''''''''''''
 * Support for Windows 64 bits
 * Support for Python 3.8
 * Upgrade V8 to 7.8
 * Support soft memory limits
 
 0.1.18 (2019-01-04)
----------------------
-
+''''''''''''''''''''
 * Support memory and time limits
 
 0.1.17 (2018-19-12)
----------------------
-
+''''''''''''''''''''
 * Upgrade libv8
 * Fix a memory leak
 
 0.1.16 (2018-07-11)
----------------------
-
+''''''''''''''''''''
 * Add wheel for Python without PyMalloc
 
 0.1.15 (2018-06-18)
----------------------
-
+''''''''''''''''''''
 * Add wheel for Python 3.7
 
 
 0.1.14 (2018-05-25)
----------------------
-
+''''''''''''''''''''
 * Add support for pip 10
 * Update package metadata
 
 0.1.13 (2018-03-15)
----------------------
-
+''''''''''''''''''''
 * Add heap_stats function
 * Fix issue with returned strings containing null bytes
 
 0.1.12 (2018-17-04)
----------------------
-
+''''''''''''''''''''
 * Remove dependency to enum
 
 0.1.11 (2017-07-11)
----------------------
-
+''''''''''''''''''''
 * Add compatibility for centos6
 
 0.1.10 (2017-03-31)
----------------------
-
+''''''''''''''''''''
 * Add the possibility to pass a custom JSON encoder in call.
 
 0.1.9 (2017-03-24)
----------------------
-
+'''''''''''''''''''
 * Fix the compilation for Ubuntu 12.04 and glibc < 2.17.
 
 0.1.8 (2017-03-02)
----------------------
-
+'''''''''''''''''''
 * Update targets build for better compatibility with old Mac OS X and linux platforms.
 
 0.1.7 (2016-10-04)
----------------------
-
+'''''''''''''''''''
 * Improve general performances of the JS execution.
 * Add the possibility to build a different version of V8 (for example with debug symbols).
 * Fix a conflict that could happens between statically linked libraries and dynamic ones.
 
 0.1.6 (2016-08-12)
----------------------
-
+'''''''''''''''''''
 * Add error message when py_mini_racer sdist fails to build asking to update pip in order to download the pre-compiled wheel instead of the source distribution.
 
 0.1.5 (2016-08-04)
----------------------
-
+'''''''''''''''''''
 * Build py_mini_racer against a static Python. When built against a shared library python, it doesn't work with a static Python.
 
 0.1.4 (2016-08-04)
----------------------
-
+'''''''''''''''''''
 * Ensure JSEvalException message is converted to unicode
 
 0.1.3 (2016-08-04)
----------------------
-
+'''''''''''''''''''
 * Fix extension loading for python3
 * Add a make target for building distributions (sdist + wheels)
 * Fix eval conversion for python 3
 
 0.1.2 (2016-08-03)
----------------------
-
+'''''''''''''''''''
 * Fix date support
 * Fix Dockerfile for generating python3 wheels
 
 
 0.1.1 (2016-08-02)
----------------------
-
+'''''''''''''''''''
 * Fix sdist distribution.
 
 
 0.1.0 (2016-08-01)
----------------------
-
+'''''''''''''''''''
 * First release on PyPI.