Skip to content

Commit b5ad7a5

Browse files
committed
Update md files.
1 parent 4b2d02a commit b5ad7a5

File tree

8 files changed

+54
-106
lines changed

8 files changed

+54
-106
lines changed

CHANGELOG CHANGELOG.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
1-
2-
Version 0.1.7:
1+
## Version 0.1.7:
32

43
2004-04-30:
54

65
- Added scientific calculator example (calc1)
76
- Added support for error-handling rules
87
- Added support for rule handlers to raise errors
98

10-
Version 0.1.6:
9+
## Version 0.1.6:
1110

1211
2004-04-30:
1312

1413
- Added ANSI C parser to examples
1514

16-
Version 0.1.5:
15+
## Version 0.1.5:
1716

1817
2004-04-30:
1918

2019
- Added XML support - can now export and import parse trees to/from
2120
XML strings or xml.dom.minidom objects
2221

23-
Version 0.1.4:
22+
## Version 0.1.4:
2423

2524
2004-04-29:
2625

@@ -31,7 +30,7 @@ Version 0.1.4:
3130

3231
- tidied up and fleshed out the walkthrough document
3332

34-
Version 0.1.3:
33+
## Version 0.1.3:
3534

3635
2004-04-28:
3736

@@ -48,7 +47,7 @@ Version 0.1.3:
4847

4948
- various other fixes and tidy-ups
5049

51-
Version 0.1.2:
50+
## Version 0.1.2:
5251

5352
2004-04-25:
5453

@@ -61,7 +60,7 @@ Version 0.1.2:
6160
- added '-c' option to bison2py utility, which causes the generation
6261
of handler code as separate node classes instead of methods
6362

64-
Version 0.1.1:
63+
## Version 0.1.1:
6564

6665
2004-04-23:
6766

@@ -72,9 +71,8 @@ Version 0.1.1:
7271
7372
- added java parser example
7473

75-
Version 0.1.0:
74+
## Version 0.1.0:
7675

7776
2004-04-23:
7877

7978
- first release
80-

CREDITS

-17
This file was deleted.

CREDITS.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
PyBison was designed and written by David McNab <[email protected]>.
2+
3+
---------------------
4+
5+
Ideas for the class model were borrowed from the PLY Python Parser Builder toolkit - [http://systems.cs.uchicago.edu/ply/](http://systems.cs.uchicago.edu/ply/)
6+
7+
----------------------
8+
9+
The javaparser.l and javaparser.y files in the examples/ directory are based (almost verbatim) on scripts written by Professor Dave Binkley [http://www.cs.loyola.edu/~binkley/](http://www.cs.loyola.edu/~binkley/) at the Department of Computer Science at Loyola College in Maryland [http://www.cs.loyola.edu/](http://www.cs.loyola.edu/) (permission pending)

INSTALL

-28
This file was deleted.

INSTALL.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Install file for PyBison
2+
3+
1. Prerequisites
4+
5+
You will need:
6+
7+
- Python 2.2 or later, with development headers and libraries
8+
- GNU bison (or yacc) - www.gnu.org or gnuwin32.sf.net
9+
- GNU flex (or lex) - ditto
10+
- The Pyrex Python/C wrapper creation framework:
11+
- http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/
12+
- A standard C compiler and linker
13+
14+
2. Installing
15+
16+
- Crack the tarball somewhere convenient (eg your home directory)
17+
- cd into the top level directory of this package
18+
- become root, and type 'python setup.py install'
19+
20+
With all going well, you should see a bunch of harmless warning messages
21+
from the compilation of bison.c, but no errors.
22+
23+
The following commands will verify if the installation succeeded:
24+
25+
```bash
26+
$ which bison2py
27+
/usr/bin/bison2py
28+
$ python -c "import bison"
29+
```

COPYING LICENSE.md

File renamed without changes.

README

-43
This file was deleted.

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,26 @@ I just added the one-line installation-script and colorfied the syntax-errors th
99
### Global Python Installation (sudo needed)
1010
Needs sudo for the installation of the following dependencies:
1111
- **apt-get:** bison, flex
12+
- `sudo apt install bison flex`
1213
- **pip3**: cython, six, pyrex, pybison itself
14+
- `pip3 install -U cython six pyrex pybison`
1315

1416
Install with:
15-
```sh
17+
```bash
1618
curl -s https://raw.githubusercontent.com/da-h/pybison/master/install_global.sh | bash
1719
```
1820

1921
### Virtualenv Python Installation (no sudo needed)
2022
First, install the dependencies
21-
```sh
23+
```bash
2224
sudo apt-get install bison flex
2325
```
2426
Now, install with:
25-
```sh
27+
```bash
2628
curl -s https://raw.githubusercontent.com/da-h/pybison/master/install_venv.sh | bash
2729
```
2830

29-
30-
31+
----------------------------------------------------------
3132

3233
For further information, please read the following original **README**:
3334

@@ -67,6 +68,5 @@ The other frameworks utilise a fiddly script syntax -
6768

6869
## How do I use this?
6970

70-
Refer to the INSTALL file for setting up.
71-
Refer to the examples and the doco for usage.
72-
71+
Refer to the [INSTALL](INSTALL.md) file for setting up.
72+
Refer to the [examples](examples) and the [docs](docs) for usage.

0 commit comments

Comments
 (0)